From d54620318844e05d877ba752ea1738fef4e4c36d Mon Sep 17 00:00:00 2001 From: Michel Hidalgo Date: Fri, 8 May 2020 17:05:36 -0300 Subject: [PATCH] Update README.md with feature documentation. (#102) Signed-off-by: Michel Hidalgo --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f6b23fa..23cbe0b0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # rmw_implementation -Implementation of ROS middleware functions used in C++. +Proxy implementation of the ROS 2 Middleware Interface, forwarding calls to the chosen (and dynamically loaded) `rmw` implementation. +`RMW_IMPLEMENTATION` environment variable, if set, allows the user to select one of the available `rmw` implementations. +Otherwise, the default `rmw` implementation will be used. +Refer to `rmw_implementation_cmake` package to learn about this default. + ## Quality Declaration