Skip to content

Commit d37f9fe

Browse files
stephane-caronStéphane Caron
authored andcommitted
Reorganize the README
1 parent 7b0e179 commit d37f9fe

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,32 @@ Importing a description for the first time automatically downloads and caches fi
1515
pip install robot_descriptions
1616
```
1717

18-
## Other languages
18+
## Usage
1919

20-
| ![C++](https://img.shields.io/badge/C%2B%2B-00599C?logo=c%2B%2B&logoColor=white) | [robot\_descriptions.cpp](https://github.com/mayataka/robot_descriptions.cpp) |
21-
|--|--|
20+
The library provides a `load_robot_description` function for each of the following robotics software:
2221

23-
## Usage
22+
| Software | Loader |
23+
|-------------|------------------------------------------|
24+
| iDynTree | `robot_descriptions.loaders.idyntree` |
25+
| MuJoCo | `robot_descriptions.loaders.mujoco` |
26+
| Pinocchio | `robot_descriptions.loaders.pinocchio` |
27+
| PyBullet | `robot_descriptions.loaders.pybullet` |
28+
| RoboMeshCat | `robot_descriptions.loaders.robomeshcat` |
29+
| yourdfpy | `robot_descriptions.loaders.yourdfpy` |
2430

25-
Import the robot description you are interested in directly as a submodule of ``robot_descriptions``:
31+
The function loads a robot description from its name, and returns an instance directly usable in the target software. For example:
32+
33+
```python
34+
from robot_descriptions.loaders.pinocchio import load_robot_description
35+
36+
robot = load_robot_description("upkie_description")
37+
```
38+
39+
Loading will automatically download the robot description if you don't have it already, and cache it to a local directory.
40+
41+
### Import as submodule
42+
43+
You can also import a robot description directly as a submodule of ``robot_descriptions``:
2644

2745
```python
2846
from robot_descriptions import my_robot_description
@@ -53,30 +71,9 @@ The import will automatically download the robot description if you don't have i
5371

5472
Some robot descriptions include additional fields. For instance, the ``iiwa_description`` exports ``URDF_PATH_POLYTOPE_COLLISION`` with more detailed collision meshes.
5573

56-
### Loaders
57-
58-
The library also provides a `load_robot_description` function for each of the following robotics software:
59-
60-
| Software | Loader |
61-
|-------------|------------------------------------------|
62-
| iDynTree | `robot_descriptions.loaders.idyntree` |
63-
| MuJoCo | `robot_descriptions.loaders.mujoco` |
64-
| Pinocchio | `robot_descriptions.loaders.pinocchio` |
65-
| PyBullet | `robot_descriptions.loaders.pybullet` |
66-
| RoboMeshCat | `robot_descriptions.loaders.robomeshcat` |
67-
| yourdfpy | `robot_descriptions.loaders.yourdfpy` |
68-
69-
The function loads a robot description from its name, and returns an instance directly usable in the target software. For example:
70-
71-
```python
72-
from robot_descriptions.loaders.pinocchio import load_robot_description
73-
74-
robot = load_robot_description("upkie_description")
75-
```
76-
7774
## Examples
7875

79-
Load a robot description:
76+
Loading a robot description:
8077

8178
- [iDynTree](https://github.com/robot-descriptions/robot_descriptions.py/tree/master/examples/load_in_idyntree.py)
8279
- [MuJoCo](https://github.com/robot-descriptions/robot_descriptions.py/tree/master/examples/load_in_mujoco.py)
@@ -85,7 +82,7 @@ Load a robot description:
8582
- [RoboMeshCat](https://github.com/robot-descriptions/robot_descriptions.py/tree/master/examples/load_in_robomeshcat.py)
8683
- [yourdfpy](https://github.com/robot-descriptions/robot_descriptions.py/tree/master/examples/load_in_yourdfpy.py)
8784

88-
Visualize a robot description:
85+
Visualizing a robot description:
8986

9087
- [MeshCat](https://github.com/robot-descriptions/robot_descriptions.py/tree/master/examples/show_in_meshcat.py)
9188
- [MuJoCo](https://github.com/robot-descriptions/robot_descriptions.py/tree/master/examples/show_in_mujoco.py)
@@ -233,3 +230,10 @@ New robot descriptions are welcome! Check out the [guidelines](https://github.co
233230
## Thanks
234231

235232
Thanks to the maintainers of all the git repositories that made these robot descriptions available.
233+
234+
## See also
235+
236+
### Robot descriptions in other languages
237+
238+
| ![C++](https://img.shields.io/badge/C%2B%2B-00599C?logo=c%2B%2B&logoColor=white) | [robot\_descriptions.cpp](https://github.com/mayataka/robot_descriptions.cpp) |
239+
|--|--|

0 commit comments

Comments
 (0)