Skip to content

Commit 4a10f11

Browse files
stephane-caronStéphane Caron
authored andcommitted
Move examples up in the README
1 parent 138d4e6 commit 4a10f11

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,24 @@ The import will automatically download the robot description if you don't have i
5252

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

55+
## Examples
56+
57+
Load a robot description:
58+
59+
- [MuJoCo](examples/load_in_mujoco.py)
60+
- [Pinocchio](examples/load_in_pinocchio.py)
61+
- [PyBullet](examples/load_in_pybullet.py)
62+
63+
Visualize a robot description:
64+
65+
- [MeshCat](examples/show_in_meshcat.py)
66+
- [MuJoCo](examples/show_in_mujoco.py)
67+
- [PyBullet](examples/show_in_pybullet.py)
68+
- [yourdfpy](examples/show_in_yourdfpy.py)
69+
5570
## Command line tool
5671

57-
The command line tool can be used to display any of the robot descriptions below. For example:
72+
The command line tool can be used to visualize any of the robot descriptions below. For example:
5873

5974
```console
6075
robot_descriptions show solo_description
@@ -104,21 +119,6 @@ Available robot descriptions ([gallery](https://github.com/robot-descriptions/aw
104119

105120
New robot descriptions are welcome! Check out the [guidelines](CONTRIBUTING.md) then open a PR.
106121

107-
## Examples
108-
109-
Load a robot description in:
110-
111-
- [MuJoCo](examples/load_in_mujoco.py)
112-
- [Pinocchio](examples/load_in_pinocchio.py)
113-
- [PyBullet](examples/load_in_pybullet.py)
114-
115-
Visualize a robot description usingf:
116-
117-
- [MeshCat](examples/show_in_meshcat.py)
118-
- [MuJoCo](examples/show_in_mujoco.py)
119-
- [PyBullet](examples/show_in_pybullet.py)
120-
- [yourdfpy](examples/show_in_yourdfpy.py)
121-
122122
## Thanks
123123

124124
Thanks to the maintainers of all the git repositories that made these robot descriptions available.

0 commit comments

Comments
 (0)