Skip to content

Commit

Permalink
Improvement of the README.md (ros-controls#384)
Browse files Browse the repository at this point in the history
* 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 <christophfroehlich@users.noreply.github.com>

---------

Co-authored-by: Christoph Fröhlich <christophfroehlich@users.noreply.github.com>
  • Loading branch information
Nils-ChristianIseke and christophfroehlich authored Dec 5, 2023
1 parent 4c5bbb8 commit 97c5ad8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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`.

Expand Down

0 comments on commit 97c5ad8

Please sign in to comment.