Skip to content

update README #1128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged

update README #1128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
![GitHub_Action_Windows_CI](https://github.com/AtsushiSakai/PythonRobotics/workflows/Windows_CI/badge.svg)
[![Build status](https://ci.appveyor.com/api/projects/status/sb279kxuv1be391g?svg=true)](https://ci.appveyor.com/project/AtsushiSakai/pythonrobotics)

Python codes for robotics algorithm.
Python codes and textbook for robotics algorithm.


# Table of Contents
Expand Down Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started_main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/index_main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading