|
6 | 6 | Welcome to PythonRobotics's documentation!
|
7 | 7 | ==========================================
|
8 | 8 |
|
9 |
| -Python codes for robotics algorithm. The project is on `GitHub`_. |
| 9 | +"PythonRobotics" is a Python code collections and html based text book |
| 10 | +(This document) for robotics algorithm, which is developed on `GitHub`_. |
10 | 11 |
|
11 |
| -This is a Python code collection of robotics algorithms. |
| 12 | +See this section (:ref:`What is PythonRobotics?`) for more details of this project. |
12 | 13 |
|
13 |
| -Features: |
| 14 | +This project is `the one of the most popular open-source software (OSS) in |
| 15 | +the field of robotics on GitHub`_. |
| 16 | +This is `user comments about this project`_, and |
| 17 | +this graph shows GitHub star history of this project: |
14 | 18 |
|
15 |
| -1. Easy to read for understanding each algorithm's basic idea. |
| 19 | +.. image:: https://api.star-history.com/svg?repos=AtsushiSakai/PythonRobotics&type=Date |
| 20 | + :alt: Star History |
| 21 | + :width: 80% |
| 22 | + :align: center |
16 | 23 |
|
17 |
| -2. Widely used and practical algorithms are selected. |
18 | 24 |
|
19 |
| -3. Minimum dependency. |
20 |
| - |
21 |
| -See this paper for more details: |
22 |
| - |
23 |
| -- `[1808.10703] PythonRobotics: a Python code collection of robotics |
24 |
| - algorithms`_ (`BibTeX`_) |
25 |
| - |
26 |
| - |
27 |
| -.. _`[1808.10703] PythonRobotics: a Python code collection of robotics algorithms`: https://arxiv.org/abs/1808.10703 |
28 |
| -.. _BibTeX: https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib |
29 | 25 | .. _GitHub: https://github.com/AtsushiSakai/PythonRobotics
|
| 26 | +.. _`user comments about this project`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/users_comments.md |
| 27 | +.. _`MIT license`: https://github.com/AtsushiSakai/PythonRobotics/blob/master/LICENSE |
| 28 | +.. _`the one of the most popular open-source software (OSS) in the field of robotics on GitHub`: https://github.com/topics/robotics |
30 | 29 |
|
| 30 | +---------------------------------- |
31 | 31 |
|
32 | 32 | .. toctree::
|
33 | 33 | :maxdepth: 2
|
34 |
| - :caption: Contents |
| 34 | + :caption: Table of Contents |
35 | 35 |
|
36 | 36 | getting_started
|
37 | 37 | modules/1_introduction/introduction
|
|
0 commit comments