File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -16,6 +16,7 @@ We also provide [ROS C++](https://github.com/ai-winter/ros_motion_planning) vers
1616
1717# Quick Start
1818
19+ ## Overview
1920The file structure is shown below
2021
2122```
@@ -41,12 +42,14 @@ python_motion_planning
4142* The local planning algorithm implementation is in the folder ` local_planner ` .
4243* The curve generation algorithm implementation is in the folder ` curve_generation ` .
4344
45+ ## Dependencies
4446The code was tested in python=3.10. To install other dependencies, please run the following command in shell.
4547
4648``` shell
4749pip install -r requirements.txt
4850```
4951
52+ ## Run Example
5053To start simulation, open the folder ` example ` and select the algorithm, for example
5154
5255``` python
@@ -70,6 +73,9 @@ if __name__ == '__main__':
7073 planner.run()
7174```
7275
76+ You can also refer to the examples in the documentations generated using the following method.
77+ ## Documentation
78+
7379This repository also support auto-generated documentation using mkdocs. Enter the root directory and run
7480
7581``` shell
You can’t perform that action at this time.
0 commit comments