From 97c5ad848d9225543181342e984428bc3e4ad2a9 Mon Sep 17 00:00:00 2001 From: Nils-Christian Iseke <48475933+Nils-ChristianIseke@users.noreply.github.com> Date: Tue, 5 Dec 2023 22:29:11 +0100 Subject: [PATCH] Improvement of the README.md (#384) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update README.md Rename Getting Started to Structure and added a new Getting Started section that links to the installation documentation. * Update README.md * Update README.md Co-authored-by: Christoph Fröhlich --------- Co-authored-by: Christoph Fröhlich --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d86e21bd4..96995c74a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ It consists of simple implementations that demonstrate different concepts. Choos 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. +## Getting Started + +Follow the steps provided in the [documentation](https://control.ros.org/master/doc/ros2_control_demos/doc/index.html#installation) to install ros2_control_demos. + + ## Content The following examples are part of this demo repository: @@ -65,7 +70,7 @@ The following examples are part of this demo repository: * Example 14: ["Modular robots with actuators not providing states and with additional sensors"](example_14) -## Getting started +## Structure The repository is structured into `example_XY` folders that fully contained packages with names `ros2_control_demos_example_XY`.