From 6a6726d4b51a5a03d3eff3b774f4c79d099e7998 Mon Sep 17 00:00:00 2001 From: Nils-Christian Iseke <48475933+Nils-ChristianIseke@users.noreply.github.com> Date: Tue, 5 Dec 2023 21:48:07 +0100 Subject: [PATCH 1/3] Update README.md Rename Getting Started to Structure and added a new Getting Started section that links to the installation documentation. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d86e21bd4..9828220ea 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 + +1. Follow the steps provided in the [documentation](https://control.ros.org/master/doc/ros2_control_demos/doc/index.html#installation) to setup your ros2 workspace. + + ## 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`. From cfeabdff860be217175944f62ddbd77fadc07747 Mon Sep 17 00:00:00 2001 From: Nils-Christian Iseke <48475933+Nils-ChristianIseke@users.noreply.github.com> Date: Tue, 5 Dec 2023 21:57:22 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9828220ea..ae69ce3b4 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ If you want to have rather step by step manual how to do things with `ros2_contr ## Getting Started -1. Follow the steps provided in the [documentation](https://control.ros.org/master/doc/ros2_control_demos/doc/index.html#installation) to setup your ros2 workspace. +1. 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 From 63164d98dce42bcbfdda34902dafc9fa5d3d3d34 Mon Sep 17 00:00:00 2001 From: Nils-Christian Iseke <48475933+Nils-ChristianIseke@users.noreply.github.com> Date: Tue, 5 Dec 2023 22:20:31 +0100 Subject: [PATCH 3/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Christoph Fröhlich --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae69ce3b4..96995c74a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ If you want to have rather step by step manual how to do things with `ros2_contr ## Getting Started -1. 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. +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