diff --git a/README.md b/README.md index 08b1a45..a1e1dd5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ +../images/Logo-ROS_2-Main.jpg ../images/ferris.jpg # examples -Example packages for ros2-rust +The aim of this project is to familiarise people with the [Ros2](https://docs.ros.org) +[Rust](https://www.rust-lang.org/) api - +[rclrs](https://github.com/ros2-rust/ros2_rust) - and at the same time to provide more and more application examples for it. Certain nodes are offered in separate packages to create a more relaxed experience for the user and to better address different topics. +## Getting started +Before you can do anything with this project, you first have to install a few dependencies. Please follow the [installation process](https://github.com/ros2-rust/ros2_rust/blob/main/README.md) provided by the ros2-rust main repository. +Once you've successfully installed Ros2 and ros2-rust, you need to load this project into your `workspace/src`: +``` +git clone https://github.com/ros2-rust/examples.git /path/to/your/workspace/src/ +``` +Then you'll need to compile your workspace with and source the ros2 installation with: +``` +cd WORKSPACE +colcon build +source install/setup.bash +``` +Then you'll be able to run some nodes! diff --git a/images/Logo-ROS_2-Main.jpg b/images/Logo-ROS_2-Main.jpg new file mode 100755 index 0000000..b4b2151 Binary files /dev/null and b/images/Logo-ROS_2-Main.jpg differ diff --git a/images/ferris.jpg b/images/ferris.jpg new file mode 100755 index 0000000..65d7487 Binary files /dev/null and b/images/ferris.jpg differ