From b8dd69e7b62995f189d13671c62d7aa76f638d96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?= Date: Thu, 17 Aug 2023 15:51:42 +0200 Subject: [PATCH] Add info about ROS 2 distro (#345) --- README.md | 2 +- doc/index.rst | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8a1276e73..3855e02ac 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Licence](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) This repository provides examples for functionalities and capabilities of `ros2_control` framework. -It consists of simple implementations that demonstrate different concepts. +It consists of simple implementations that demonstrate different concepts. Choose the right branch of this repository matching you ROS 2 distribution as well as the full documentation on [control.ros.org](https://control.ros.org), see [this table](#build-status). If you want to have rather step by step manual how to do things with `ros2_control` checkout the [ros-control/roscon2022_workshop](https://github.com/ros-controls/roscon2022_workshop) repository. diff --git a/doc/index.rst b/doc/index.rst index a00f3c12f..68ed96e2a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -76,12 +76,15 @@ Example 12: "Controller chaining" Installation ===================== -You can install the demos manually or use the provided docker file. +You can install the demos locally or use the provided docker file. -Manual Install ---------------- -First, you have to install `ROS 2 on your computer `__. +Local installation +------------------ + +If you have ROS 2 installed already, choose the right version of this documentation and branch of the ``ros2_control_demos`` repository matching you ROS 2 distribution, see `this table `__. + +Otherwise, install `ROS 2 {DISTRO} on your computer `__. .. note:: @@ -98,7 +101,7 @@ Download the ``ros2_control_demos`` repository and install its dependencies with mkdir -p ~/ros2_ws/src cd ~/ros2_ws/src - git clone https://github.com/ros-controls/ros2_control_demos + git clone https://github.com/ros-controls/ros2_control_demos -b {REPOS_FILE_BRANCH} cd ~/ros2_ws/ rosdep update --rosdistro=$ROS_DISTRO sudo apt-get update