mirror
/
r2r
mirror of https://github.com/sequenceplanner/r2r.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
Martin Dahl 2021-07-25 13:06:40 +02:00
parent a170c6d647
commit 78d174d534
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -15,7 +15,7 @@ How to use
4. The bindings will rebuild automatically if/when you source your workspace(s). 4. The bindings will rebuild automatically if/when you source your workspace(s).
5. If you make changes to existing message types, run cargo clean -p msg_gen to force recompilation of the rust message types on the next build. 5. If you make changes to existing message types, run cargo clean -p msg_gen to force recompilation of the rust message types on the next build.
A couple of examples are included in examples/ Examples of how to use the crate are included in examples/
``` ```
. /opt/ros/foxy/setup.sh . /opt/ros/foxy/setup.sh
cargo build cargo build
@ -28,19 +28,18 @@ An example application can be found here <https://github.com/sequenceplanner/r2r
What works? What works?
-------------------- --------------------
- Up to date with ROS2 ~Dashing~ ~Eloquent~ Foxy - Up to date with ROS2 ~Dashing~ ~Eloquent~ ~Foxy~ Galactic
- Building Rust types - Building Rust types
- Publish/subscribe - Publish/subscribe
- Services - Services
- Actions
- Parameters - Parameters
TODO TODO
-------------------- --------------------
- The code generation is currently just a big hack. Needs cleanup and refactoring. - Documentation. (For now, look at the examples.)
- General cleanup and error handling.
- Expose more of the RCL like QoS settings. - Expose more of the RCL like QoS settings.
- Action types?
- Async API!
*** ***
<!-- <!--