Skip to content

Commit 648432e

Browse files
authored
Update README.md
1 parent 4a72ac7 commit 648432e

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,24 @@
22

33
A best-effort A*-on-visibility-graph implementation for path planning in obstacles maps where obstacles and the robot itself are assumed to be round.
44

5+
## Installation
6+
7+
```bash
8+
pip install git+https://github.com/bit-bots/bitbots_rust_nav
9+
```
10+
11+
## API
12+
513
It exports three classes
614

7-
## `RoundObstacle`
15+
### `RoundObstacle`
816

917
Represents a round obstacle with public fields `center: (float, float)` and `radius: float`. Can be created with the constructor `RoundObstacle(center, radius)`
1018

11-
## `ObstacleMapConfig`
19+
### `ObstacleMapConfig`
1220

1321
Represents all configuration values for how obstacles should be treated with public fields `dilate: float` - the value by which the radii of the obstacles should be dilated (this should be set to approximately your own radius) - and `num_vertices` - the number of vertices the polygons approximating the round obstacles should have. Can be created with the constructor `ObstacleMapConfig(dilate, num_vertices)`
1422

15-
## `ObstacleMap`
23+
### `ObstacleMap`
1624

1725
Represents a set of obstacles on a plane with a given config. This has two fields: `config: ObstacleMapConfig` and `obstacles: [RoundObstacle]`. Can be created with the constructor `ObstacleMap(config, obstacles)`

0 commit comments

Comments
 (0)