Update the design document (#108)

* Cleanup the README file. Signed-off-by: Chris Lalancette <[email protected]> * Update the design document. Signed-off-by: Chris Lalancette <[email protected]> * Apply suggestions from code review Co-authored-by: Yadu <[email protected]> Signed-off-by: Chris Lalancette <[email protected]> * Fixes from review. Signed-off-by: Chris Lalancette <[email protected]> * Updates from review. Signed-off-by: Chris Lalancette <[email protected]> --------- Signed-off-by: Chris Lalancette <[email protected]> Co-authored-by: Yadu <[email protected]>
ros2 · Mar 5, 2024 · 02dddff · 02dddff
1 parent 191a56b
commit 02dddff
Show file tree

Hide file tree

Showing 2 changed files with 384 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,6 @@ cd ~/ws_rmw_zenoh
 rosdep install --from-paths src --ignore-src --rosdistro <DISTRO> -y # replace <DISTRO> with ROS 2 distro of choice
 source /opt/ros/<DISTRO>/setup.bash # replace <DISTRO> with ROS 2 distro of choice
 colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release
-
 ```
 
 ## Test
@@ -56,7 +55,6 @@ ros2 run rmw_zenoh_cpp rmw_zenohd
 export RMW_IMPLEMENTATION=rmw_zenoh_cpp
 ros2 run demo_nodes_cpp talker
 ```
-> Note: Ignore all the warning printouts.
 
 ### Run the `listener`
 ```bash
@@ -66,7 +64,6 @@ ros2 run demo_nodes_cpp listener
 ```
 
 The listener node should start receiving messages over the `/chatter` topic.
-> Note: Ignore all the warning printouts.
 
 ## Configuration
 `rmw_zenoh` relies on separate configurations files to configure the Zenoh `router` and `session` respectively.