Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hanruihua committed Dec 8, 2024
1 parent 566bc01 commit c475a88
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Welcome to IR-SIM's documentation!
==================================

**Intelligent Robotics Simulation (IR-SIM)** is a Python based lightweight 2D robotics simulator that provides a simple and easy-to-use interface for simulating robot behaviors in a 2D environment. The simulator is designed to be used for educational purposes and research in the field of robotics.
**Intelligent Robotics Simulation (IR-SIM)** is a Python based lightweight robotics simulator that provides a quite simple and easy-to-use interface for simulating various robot behaviors. The simulator is designed for research and educational purposes in the field of robotics.

It provides the following features:
- A versatile and easy-to-use framework for simulating a variety of robot platforms with kinematics and sensors.
Expand All @@ -15,6 +15,11 @@ It provides the following features:
- Ideal for developing and testing algorithms related to robot navigation, motion planning, reinforcement learning.


| Robot | Car |
| :---------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: |
| ![robot](https://github.com/user-attachments/assets/5930b088-d400-4943-8ded-853c22eae75b) | ![car](https://github.com/user-attachments/assets/3257abc1-8bed-40d8-9b51-e5d90b06ee06) |

.. toctree::
:maxdepth: 2
:caption: Getting Started:
Expand Down

0 comments on commit c475a88

Please sign in to comment.