mirror of
https://github.com/AtsushiSakai/PythonRobotics.git
synced 2026-04-22 03:00:22 -04:00
update README (#1128)
This commit is contained in:
12
README.md
12
README.md
@@ -6,7 +6,7 @@
|
||||

|
||||
[](https://ci.appveyor.com/project/AtsushiSakai/pythonrobotics)
|
||||
|
||||
Python codes for robotics algorithm.
|
||||
Python codes and textbook for robotics algorithm.
|
||||
|
||||
|
||||
# Table of Contents
|
||||
@@ -73,9 +73,9 @@ Python codes for robotics algorithm.
|
||||
* [1Password](#1password)
|
||||
* [Authors](#authors)
|
||||
|
||||
# What is this?
|
||||
# What is PythonRobotics?
|
||||
|
||||
This is a Python code collection of robotics algorithms.
|
||||
PythonRobotics is a Python code collection and a [textbook](https://atsushisakai.github.io/PythonRobotics/index.html) of robotics algorithms.
|
||||
|
||||
Features:
|
||||
|
||||
@@ -90,7 +90,7 @@ See this paper for more details:
|
||||
- [\[1808\.10703\] PythonRobotics: a Python code collection of robotics algorithms](https://arxiv.org/abs/1808.10703) ([BibTeX](https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib))
|
||||
|
||||
|
||||
# Requirements
|
||||
# Requirements to run the code
|
||||
|
||||
For running each sample code:
|
||||
|
||||
@@ -116,13 +116,13 @@ For development:
|
||||
|
||||
- [pycodestyle](https://pypi.org/project/pycodestyle/) (for code style check)
|
||||
|
||||
# Documentation
|
||||
# Documentation (Textbook)
|
||||
|
||||
This README only shows some examples of this project.
|
||||
|
||||
If you are interested in other examples or mathematical backgrounds of each algorithm,
|
||||
|
||||
You can check the full documentation online: [Welcome to PythonRobotics’s documentation\! — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/index.html)
|
||||
You can check the full documentation (textbook) online: [Welcome to PythonRobotics’s documentation\! — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/index.html)
|
||||
|
||||
All animation gifs are stored here: [AtsushiSakai/PythonRoboticsGifs: Animation gifs of PythonRobotics](https://github.com/AtsushiSakai/PythonRoboticsGifs)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ What is PythonRobotics?
|
||||
|
||||
This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms.
|
||||
|
||||
This is developped under `MIT license`_ and on `GitHub`_.
|
||||
This is developed under `MIT license`_ and on `GitHub`_.
|
||||
|
||||
The focus of the project is on autonomous navigation, and the goal is for beginners in robotics to understand the basic ideas behind each algorithm.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
Welcome to PythonRobotics's documentation!
|
||||
==========================================
|
||||
|
||||
"PythonRobotics" is a Python code collections and html based text book
|
||||
"PythonRobotics" is a Python code collections and textbook
|
||||
(This document) for robotics algorithm, which is developed on `GitHub`_.
|
||||
|
||||
See this section (:ref:`What is PythonRobotics?`) for more details of this project.
|
||||
|
||||
Reference in New Issue
Block a user