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 2020-09-29 10:03:03 +02:00
parent 96ca41fdfb
commit 9bc75b69ac
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -3,6 +3,8 @@ R2R - Minimal ROS2 Rust bindings
Minimal bindings for ROS2 that do *not* require hooking in to the ROS2 build infrastructure. If you want a more ROS-oriented approach, see <https://github.com/ros2-rust/ros2_rust>. In these bindings, convenience Rust types are created by calling into the c introspection libraries to circumvent the .msg/.idl pipeline. The convenience types can be ignored when you need to trade convenience for performance, e.g. treating large chunks of data manually. Minimal bindings for ROS2 that do *not* require hooking in to the ROS2 build infrastructure. If you want a more ROS-oriented approach, see <https://github.com/ros2-rust/ros2_rust>. In these bindings, convenience Rust types are created by calling into the c introspection libraries to circumvent the .msg/.idl pipeline. The convenience types can be ignored when you need to trade convenience for performance, e.g. treating large chunks of data manually.
Manual is available on github pages <https://sequenceplanner.github.io/r2r/>
How to use How to use
-------------------- --------------------
1. Make sure you have libclang installed. (e.g. libclang-dev on ubuntu) 1. Make sure you have libclang installed. (e.g. libclang-dev on ubuntu)
@ -24,11 +26,12 @@ What works?
- Up to date with ROS2 ~Dashing~ ~Eloquent~ Foxy - Up to date with ROS2 ~Dashing~ ~Eloquent~ Foxy
- Building Rust types - Building Rust types
- Publish/subscribe - Publish/subscribe
- Services (servers, not clients yet) - Services
- Parameters - Parameters
TODO TODO
-------------------- --------------------
- The code generation is currently just a big hack. Needs cleanup and refactoring. - The code generation is currently just a big hack. Needs cleanup and refactoring.
- Expose more of the RCL like QoS settings and logging. - Expose more of the RCL like QoS settings.
- Services and action types... - Action types?
- Async API!