Move rclrs_examples to examples/minimal_pub_sub (#163)

Author: nnmm

.github/workflows/rust.yml

@@ -91,7 +91,7 @@ jobs:
       run: |
         cd ${{ steps.build.outputs.ros-workspace-directory-name }}
         . /opt/ros/${{ matrix.ros_distro }}/setup.sh
-        for path in $(colcon list | awk '$3 == "(ament_cargo)" && $1 != "rclrs_examples" { print $2 }'); do
+        for path in $(colcon list | awk '$3 == "(ament_cargo)" && $1 != "examples_rclrs_minimal_pub_sub" { print $2 }'); do
         cd $path
         echo "Running rustdoc check in $path"
         cargo rustdoc -- -D warnings

README.md

@@ -55,7 +55,7 @@ git clone https://github.com/ros2-rust/ros2_rust.git src/ros2_rust
 vcs import src < src/ros2_rust/ros2_rust_foxy.repos
 . /opt/ros/foxy/setup.sh
 cd /src
-colcon build --packages-up-to rclrs_examples
+colcon build --packages-up-to examples_rclrs_minimal_pub_sub
 ```
 
 It's normal to see a `Some selected packages are already built in one or more underlay workspace` warning. This is because the standard message definitions that are part of ROS 2 need to be regenerated in order to create Rust bindings.
@@ -75,10 +75,10 @@ As an example, here is how to build `rclcrs_examples` with `cargo`:
 ```
 # Initial build of the package with colcon
 # Compare .cargo/config.toml with and without the --lookup-in-workspace flag to see its effect
-colcon build --packages-up-to rclrs_examples --lookup-in-workspace
+colcon build --packages-up-to examples_rclrs_minimal_pub_sub --lookup-in-workspace
 # Source the install directory
 . install/setup.sh
-cd rclrs_examples
+cd examples_rclrs_minimal_pub_sub
 # Run cargo build, or cargo check, cargo doc, etc.
 cargo build
 ```
@@ -90,15 +90,15 @@ Publisher:
 ```
 # Do this in a new terminal
 . ./install/setup.sh
-ros2 run rclrs_examples minimal_publisher
+ros2 run examples_rclrs_minimal_pub_sub minimal_publisher
 ```
 
 Subscriber:
 
 ```
 # Do this in a new terminal
 . ./install/setup.sh
-ros2 run rclrs_examples minimal_subscriber
+ros2 run examples_rclrs_minimal_pub_sub minimal_subscriber
 ```
 
 Enjoy!

examples/message_demo/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "examples_rclrs_message_demo"
+version = "0.2.0"
+authors = ["Nikolai Morin <[email protected]>"]
+edition = "2021"
+
+[[bin]]
+name = "message_demo"
+path = "src/message_demo.rs"
+
+[dependencies]
+anyhow = {version = "1", features = ["backtrace"]}
+
+[dependencies.rclrs]
+version = "*"
+
+[dependencies.rosidl_runtime_rs]
+version = "*"
+
+[dependencies.rclrs_example_msgs]
+version = "*"

examples/message_demo/package.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<?xml-model
+   href="http://download.ros.org/schema/package_format3.xsd"
+   schematypens="http://www.w3.org/2001/XMLSchema"?>
+<package format="3">
+  <name>examples_rclrs_message_demo</name>
+  <version>0.2.0</version>
+  <description>Package containing an example of message-related functionality in rclrs.</description>
+  <maintainer email="[email protected]">Nikolai Morin</maintainer>
+  <license>Apache License 2.0</license>
+
+  <build_depend>rclrs</build_depend>
+  <build_depend>rosidl_runtime_rs</build_depend>
+  <build_depend>rclrs_example_msgs</build_depend>
+
+  <exec_depend>rclrs</exec_depend>
+  <exec_depend>rosidl_runtime_rs</exec_depend>
+  <exec_depend>rclrs_example_msgs</exec_depend>
+
+  <export>
+    <build_type>ament_cargo</build_type>
+  </export>
+</package>

rclrs_examples/src/message_demo.rs renamed to examples/message_demo/src/message_demo.rs

@@ -1,5 +1,5 @@
 [package]
-name = "rclrs_examples"
+name = "examples_rclrs_minimal_pub_sub"
 version = "0.2.0"
 authors = ["Esteve Fernandez <[email protected]>"]
 edition = "2021"
@@ -12,10 +12,6 @@ path = "src/minimal_subscriber.rs"
 name = "minimal_publisher"
 path = "src/minimal_publisher.rs"
 
-[[bin]]
-name = "message_demo"
-path = "src/message_demo.rs"
-
 [dependencies]
 anyhow = {version = "1", features = ["backtrace"]}
 
@@ -27,6 +23,3 @@ version = "*"
 
 [dependencies.std_msgs]
 version = "*"
-
-[dependencies.rclrs_example_msgs]
-version = "*"

rclrs_examples/Cargo.toml renamed to examples/minimal_pub_sub/Cargo.toml

@@ -3,21 +3,19 @@
    href="http://download.ros.org/schema/package_format3.xsd"
    schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
-  <name>rclrs_examples</name>
+  <name>examples_rclrs_minimal_pub_sub</name>
   <version>0.2.0</version>
-  <description>Package containing examples of how to use the rclrs API.</description>
+  <description>Package containing an example of the publish-subscribe mechanism in rclrs.</description>
   <maintainer email="[email protected]">Esteve Fernandez</maintainer>
   <license>Apache License 2.0</license>
 
   <build_depend>rclrs</build_depend>
   <build_depend>rosidl_runtime_rs</build_depend>
   <build_depend>std_msgs</build_depend>
-  <build_depend>rclrs_example_msgs</build_depend>
 
   <exec_depend>rclrs</exec_depend>
   <exec_depend>rosidl_runtime_rs</exec_depend>
   <exec_depend>std_msgs</exec_depend>
-  <exec_depend>rclrs_example_msgs</exec_depend>
 
   <export>
     <build_type>ament_cargo</build_type>