Skip to content

Commit e93ada6

Browse files
authored
update README (AtsushiSakai#1128)
1 parent f1b171d commit e93ada6

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
![GitHub_Action_Windows_CI](https://github.com/AtsushiSakai/PythonRobotics/workflows/Windows_CI/badge.svg)
77
[![Build status](https://ci.appveyor.com/api/projects/status/sb279kxuv1be391g?svg=true)](https://ci.appveyor.com/project/AtsushiSakai/pythonrobotics)
88

9-
Python codes for robotics algorithm.
9+
Python codes and textbook for robotics algorithm.
1010

1111

1212
# Table of Contents
@@ -73,9 +73,9 @@ Python codes for robotics algorithm.
7373
* [1Password](#1password)
7474
* [Authors](#authors)
7575

76-
# What is this?
76+
# What is PythonRobotics?
7777

78-
This is a Python code collection of robotics algorithms.
78+
PythonRobotics is a Python code collection and a [textbook](https://atsushisakai.github.io/PythonRobotics/index.html) of robotics algorithms.
7979

8080
Features:
8181

@@ -90,7 +90,7 @@ See this paper for more details:
9090
- [\[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))
9191

9292

93-
# Requirements
93+
# Requirements to run the code
9494

9595
For running each sample code:
9696

@@ -116,13 +116,13 @@ For development:
116116

117117
- [pycodestyle](https://pypi.org/project/pycodestyle/) (for code style check)
118118

119-
# Documentation
119+
# Documentation (Textbook)
120120

121121
This README only shows some examples of this project.
122122

123123
If you are interested in other examples or mathematical backgrounds of each algorithm,
124124

125-
You can check the full documentation online: [Welcome to PythonRobotics’s documentation\! — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/index.html)
125+
You can check the full documentation (textbook) online: [Welcome to PythonRobotics’s documentation\! — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/index.html)
126126

127127
All animation gifs are stored here: [AtsushiSakai/PythonRoboticsGifs: Animation gifs of PythonRobotics](https://github.com/AtsushiSakai/PythonRoboticsGifs)
128128

docs/getting_started_main.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ What is PythonRobotics?
1010

1111
This is an Open Source Software (OSS) project: PythonRobotics, which is a Python code collection of robotics algorithms.
1212

13-
This is developped under `MIT license`_ and on `GitHub`_.
13+
This is developed under `MIT license`_ and on `GitHub`_.
1414

1515
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.
1616

docs/index_main.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Welcome to PythonRobotics's documentation!
77
==========================================
88

9-
"PythonRobotics" is a Python code collections and html based text book
9+
"PythonRobotics" is a Python code collections and textbook
1010
(This document) for robotics algorithm, which is developed on `GitHub`_.
1111

1212
See this section (:ref:`What is PythonRobotics?`) for more details of this project.

0 commit comments

Comments
 (0)