Suggestion for improvement of the README.md (backport #384) (#385)

* Improvement of the README.md (#384) * 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 <[email protected]> --------- Co-authored-by: Christoph Fröhlich <[email protected]> (cherry picked from commit 97c5ad8) * Update README.md --------- Co-authored-by: Nils-Christian Iseke <[email protected]> Co-authored-by: Christoph Fröhlich <[email protected]>
ros-controls · Dec 5, 2023 · e967f23 · e967f23
1 parent a4d6adb
commit e967f23
Showing 1 changed file with 6 additions and 1 deletion.
diff --git 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/humble/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`.