diff --git a/README.md b/README.md index 5f04345..5d374a2 100644 --- a/README.md +++ b/README.md @@ -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 . 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 + How to use -------------------- 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 - Building Rust types - Publish/subscribe -- Services (servers, not clients yet) +- Services - Parameters TODO -------------------- - The code generation is currently just a big hack. Needs cleanup and refactoring. -- Expose more of the RCL like QoS settings and logging. -- Services and action types... +- Expose more of the RCL like QoS settings. +- Action types? +- Async API!