Simplify README (#8)
This commit is contained in:
parent
052a0e255e
commit
1e6bee50f7
26
README.md
26
README.md
@ -1,28 +1,6 @@
|
||||
# Robot Description files for OpenArm
|
||||
|
||||
This package contains description files to generate OpenArm URDFs (Universal Robot Description Files).
|
||||
|
||||
To generate or view the URDF, install ROS2, source the setup script, and clone this package into a workspace.
|
||||
|
||||
For example, for ROS2 Humble:
|
||||
```sh
|
||||
source /opt/ros/humble/setup.bash
|
||||
mkdir -p ~/ros2_ws/src
|
||||
git clone https://github.com/enactic/openarm_description.git ~/ros2_ws/src/openarm_description
|
||||
colcon build
|
||||
source ~/ros2_ws/install/setup.bash
|
||||
```
|
||||
|
||||
Then to view the bimanual URDF:
|
||||
```sh
|
||||
ros2 launch openarm_description display_openarm.launch.py arm_type:=v10 bimanual:=true
|
||||
```
|
||||
|
||||
Or to generate a URDF:
|
||||
```sh
|
||||
URDF_NAME=openarm_bimanual.urdf
|
||||
xacro ~/ros2_ws/src/openarm_description/urdf/robot/v10.urdf.xacro arm_type:=v10 bimanual:=true > $URDF_NAME
|
||||
```
|
||||
This package contains description files to generate OpenArm URDFs (Universal Robot Description Files). See [documentation](https://docs.openarm.dev/software/description) for details.
|
||||
|
||||
## Related links
|
||||
|
||||
@ -32,7 +10,7 @@ xacro ~/ros2_ws/src/openarm_description/urdf/robot/v10.urdf.xacro arm_type:=v10
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the Apache License 2.0. See `LICENSE.txt` for details.
|
||||
[Apache License 2.0](LICENSE.txt)
|
||||
|
||||
Copyright 2025 Enactic, Inc.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user