Skip to content

Commit a2f018a

Browse files
authored
Update README (Kinovarobotics#167)
* update README to point users to binary install first, ros-testing install second, source install last * remove vsc import step no longer required because the robotiq_description package has been released. Signed-off-by: Alex Moriarty <[email protected]>
1 parent 32adc96 commit a2f018a

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ ROS2 Kortex is the official ROS2 package to interact with Kortex and its related
5252

5353

5454
## Getting started
55-
<!-- TODO(moriarty) update this when binary package is released getting most users should use binary release -->
5655

5756
1. Install ROS 2.
5857

@@ -64,35 +63,58 @@ ROS2 Kortex is the official ROS2 package to interact with Kortex and its related
6463

6564
After installing a version of ROS, source the setup.bash, which will set the `$ROS_DISTRO` environment variable.
6665

67-
2. Optional: install Cyclone DDS
66+
2. Install this package from binary
67+
```
68+
sudo apt install ros-$ROS_DISTRO-kortex-bringup
69+
```
70+
71+
3. Optional: install MoveIt Configuration and Cyclone DDS
72+
73+
If you have a 7dof arm:
74+
```
75+
sudo apt install ros-$ROS_DISTRO-kinova-gen3-7dof-robotiq-2f-85-moveit-config
76+
```
77+
If you have a 6dof arm:
78+
```
79+
sudo apt install ros-$ROS_DISTRO-kinova-gen3-6dof-robotiq-2f-85-moveit-config
80+
```
6881
If you plan to use MoveIt, it is recommended to install and use Cyclone DDS.
6982
```
7083
sudo apt install ros-$ROS_DISTRO-rmw-cyclonedds-cpp
7184
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
7285
```
7386

74-
3. Make sure that `colcon`, its extensions, and `vcs` are installed:
87+
4. Go to Usage section
88+
89+
## Contributing to this repository or building from source
90+
91+
Note: It is recommended to use a released binary version of this package and apt install it.
92+
If you want the latest version of this repository for testing latest fixes
93+
check out testing with pre-released binaries: https://docs.ros.org/en/rolling/Installation/Testing.html
94+
95+
If the bug fix you need isn't in a released version or If you want to build this repository from source or contribute back to the repository read on.
96+
97+
1. Make sure that `colcon`, its extensions, and `vcs` are installed:
7598
```
7699
sudo apt install python3-colcon-common-extensions python3-vcstool
77100
```
78101

79-
4. Create a new ROS2 workspace:
102+
2. Create a new ROS2 workspace:
80103
```
81104
export COLCON_WS=~/workspace/ros2_kortex_ws
82105
mkdir -p $COLCON_WS/src
83106
```
84107

85-
5. Pull relevant packages, install dependencies, compile, and source the workspace by using:
108+
3. Pull relevant packages, install dependencies, compile, and source the workspace by using:
86109
```
87110
cd $COLCON_WS
88111
git clone https://github.com/PickNikRobotics/ros2_kortex.git src/ros2_kortex
89-
vcs import src --skip-existing --input src/ros2_kortex/ros2_kortex.repos
90112
rosdep install --ignore-src --from-paths src -y -r
91113
colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release
92114
source install/setup.bash
93115
```
94116

95-
6. To simulate the robot with ignition or gazebo make sure to pull and build additional packages:
117+
4. To simulate the robot with ignition or gazebo make sure to pull and build additional packages:
96118
```
97119
vcs import src --skip-existing --input src/ros2_kortex/simulation.repos
98120
rosdep install --ignore-src --from-paths src -y -r

0 commit comments

Comments
 (0)