Skip to content

Commit 77225af

Browse files
committed
πŸ‡¨πŸ‡² Update file contents
1 parent 99a332a commit 77225af

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![CI](https://github.com/LandslideSIM/FastPIP.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/LandslideSIM/FastPointQuery.jl/actions/workflows/ci.yml)
44
[![Version](https://img.shields.io/badge/version-v0.1.0-pink)]()
55

6-
76
> This is a dependency package for [MaterialPointGenerator.jl](https://github.com/LandslideSIM/MaterialPointGenerator.jl), used to separate Python calls for easier management.
87
98
## Installation βš™οΈ
@@ -15,11 +14,19 @@ julia> ]
1514
(@1.11) Pkg> add FastPointQuery
1615
```
1716

17+
Documentation:
18+
19+
``julia
20+
help?>pip_query
21+
help?>get_polygon
22+
help?>readSTL2D
23+
help?>readSTL3D
24+
```
25+
1826
## Features ✨
1927
20-
- [x] point-in-polygon
21-
- [x] point-in-polyhedron
22-
- [x] surface normal vectors
28+
- [x] point(s)-in-polygon
29+
- [x] point(s)-in-polyhedron
2330
2431
## Acknowledgement πŸ‘
2532

0 commit comments

Comments
Β (0)