Merge pull request #404 from iory/docs

[docs] Add visualize-urdf command line tool
iory · Oct 29, 2024 · 1d208ff · 1d208ff
2 parents 4284a09 + 14f5343
commit 1d208ff
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,27 @@ If you would like to use `Pybullet Interface`, `open3d` and `fast-simplification
 pip install scikit-robot[all]
 ```
 
+## Command Line Tools
+
+### Visualize URDF
+
+To visualize a URDF model and inspect your robot's configuration, you can use the `visualize-urdf` command as follows:
+
+```bash
+visualize-urdf ~/.skrobot/pr2_description/pr2.urdf
+```
+
+If you experience performance issues with the default viewer, try pyrender for smoother visualization:
+
+```bash
+visualize-urdf ~/.skrobot/pr2_description/pr2.urdf --viewer pyrender
+```
+
+Running these commands should open a viewer displaying your robot’s 3D model. Below is a sample image of what you should expect.
+
+![Viewer Example](docs/image/viewer.jpg)
+
+
 ## Features
 
 - [x] Loading robot model from URDF ([examples/robot_models.py](examples/robot_models.py))

diff --git a/docs/image/viewer.jpg b/docs/image/viewer.jpg