diff --git a/README.md b/README.md index 9e56025a..d67a5c31 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # rmw_zenoh -[![build](https://github.com/ros2/rmw_zenoh/actions/workflows/build.yaml/badge.svg)](https://github.com/ros2/rmw_zenoh/actions/workflows/build.yaml) -[![style](https://github.com/ros2/rmw_zenoh/actions/workflows/style.yaml/badge.svg)](https://github.com/ros2/rmw_zenoh/actions/workflows/style.yaml) +[![build](https://github.com/ros2/rmw_zenoh/actions/workflows/build.yaml/badge.svg?branch=humble)](https://github.com/ros2/rmw_zenoh/actions/workflows/build.yaml) +[![style](https://github.com/ros2/rmw_zenoh/actions/workflows/style.yaml/badge.svg?branch=humble)](https://github.com/ros2/rmw_zenoh/actions/workflows/style.yaml) A ROS 2 RMW implementation based on Zenoh that is written using the zenoh-cpp bindings. @@ -10,8 +10,9 @@ A ROS 2 RMW implementation based on Zenoh that is written using the zenoh-cpp bi For information about the Design please visit [design](docs/design.md) page. ## Requirements -- [ROS 2](https://docs.ros.org): Rolling/Jazzy/Iron +- [ROS 2](https://docs.ros.org) +> Note: See available distro branches, eg. `jazzy`, for supported ROS 2 distributions. ## Setup @@ -22,11 +23,12 @@ The `ZENOHC_CARGO_FLAGS` CMake argument may be overwritten with other features i See [zenoh_cpp_vendor/CMakeLists.txt](./zenoh_cpp_vendor/CMakeLists.txt) for more details. ```bash +# replace with ROS 2 distro of choice mkdir ~/ws_rmw_zenoh/src -p && cd ~/ws_rmw_zenoh/src -git clone https://github.com/ros2/rmw_zenoh.git +git clone https://github.com/ros2/rmw_zenoh.git -b cd ~/ws_rmw_zenoh -rosdep install --from-paths src --ignore-src --rosdistro -y # replace with ROS 2 distro of choice -source /opt/ros//setup.bash # replace with ROS 2 distro of choice +rosdep install --from-paths src --ignore-src --rosdistro -y +source /opt/ros//setup.bash colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release ```