Skip to content

Commit 68d415a

Browse files
stephane-caronStéphane Caron
authored andcommitted
Link to robotics software from the README
1 parent f1f2fe1 commit 68d415a

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,24 @@ pip install robot_descriptions
1717

1818
## Usage
1919

20-
The library provides `load_robot_description` functions that, given a description name, return an instance directly usable in the corresponding robotics software. For example:
20+
The library provides `load_robot_description` functions that return an instance of a robot description directly usable in the corresponding software. For example:
2121

2222
```python
2323
from robot_descriptions.loaders.pinocchio import load_robot_description
2424

2525
robot = load_robot_description("upkie_description")
2626
```
2727

28-
Loaders are implemented for each of the following robotics software:
28+
Loaders are implemented for the following robotics software:
2929

30-
| Software | Loader |
31-
|-------------|------------------------------------------|
32-
| iDynTree | `robot_descriptions.loaders.idyntree` |
33-
| MuJoCo | `robot_descriptions.loaders.mujoco` |
34-
| Pinocchio | `robot_descriptions.loaders.pinocchio` |
35-
| PyBullet | `robot_descriptions.loaders.pybullet` |
36-
| RoboMeshCat | `robot_descriptions.loaders.robomeshcat` |
37-
| yourdfpy | `robot_descriptions.loaders.yourdfpy` |
30+
| Software | Loader |
31+
|--------------------------------------------------------------|------------------------------------------|
32+
| [iDynTree](https://github.com/robotology/idyntree) | `robot_descriptions.loaders.idyntree` |
33+
| [MuJoCo](https://github.com/deepmind/mujoco) | `robot_descriptions.loaders.mujoco` |
34+
| [Pinocchio](https://github.com/stack-of-tasks/pinocchio) | `robot_descriptions.loaders.pinocchio` |
35+
| [PyBullet](https://pybullet.org/) | `robot_descriptions.loaders.pybullet` |
36+
| [RoboMeshCat](https://github.com/petrikvladimir/RoboMeshCat) | `robot_descriptions.loaders.robomeshcat` |
37+
| [yourdfpy](https://github.com/clemense/yourdfpy/) | `robot_descriptions.loaders.yourdfpy` |
3838

3939
Loading will automatically download the robot description if needed, and cache it to a local directory.
4040

@@ -233,7 +233,7 @@ Thanks to the maintainers of all the git repositories that made these robot desc
233233

234234
## See also
235235

236-
### Robot descriptions in other languages
236+
Robot descriptions in other languages:
237237

238238
| ![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) |
239239
|--|--|

0 commit comments

Comments
 (0)