From 26bc60704c6c5ebc1e5f5599990ec191ccb82eb1 Mon Sep 17 00:00:00 2001 From: Marya Belanger Date: Wed, 11 Dec 2019 19:39:06 +0300 Subject: [PATCH] New README (#942) * New README * dashing to eloquent for api docs * remove "accepted" Co-Authored-By: Chris Lalancette * components > APIs Co-Authored-By: Chris Lalancette --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..37d875e69c --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# rclcpp + +This repository contains the source code for the ROS Client Library for C++ package, included with a standard install of any ROS 2 distro. + +rclcpp provides the standard C++ API for interacting with ROS 2. + +## Usage + +`#include "rclcpp/rclcpp.hpp"` allows use of the most common elements of the ROS 2 system. + +Visit the [rclcpp API documentation](http://docs.ros2.org/eloquent/api/rclcpp/) for a complete list of its main components. + +### Examples + +The ROS 2 tutorials [Writing a simple publisher and subscriber](https://index.ros.org/doc/ros2/Tutorials/Writing-A-Simple-Cpp-Publisher-And-Subscriber/) +and [Writing a simple service and client](https://index.ros.org/doc/ros2/Tutorials/Writing-A-Simple-Cpp-Service-And-Client/) +contain some examples of rclcpp APIs in use.