26bc60704c
* New README * dashing to eloquent for api docs * remove "accepted" Co-Authored-By: Chris Lalancette <clalancette@openrobotics.org> * components > APIs Co-Authored-By: Chris Lalancette <clalancette@openrobotics.org>
17 lines
780 B
Markdown
17 lines
780 B
Markdown
# 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.
|