Skip to content

Commit 9e6b4a0

Browse files
Add readmes in every example folder (#262)
1 parent 617160a commit 9e6b4a0

File tree

7 files changed

+36
-0
lines changed

7 files changed

+36
-0
lines changed

example_1/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ros2_control_demo_example_1
2+
3+
*RRBot* - or ''Revolute-Revolute Manipulator Robot'' - a simple position controlled robot with one hardware interface. This example also demonstrates the switching between different controllers.
4+
5+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_1/doc/userdoc.html).

example_2/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# ros2_control_demo_example_2
2+
3+
*DiffBot*, or ''Differential Mobile Robot'', is a simple mobile base with differential drive.
4+
The robot is basically a box moving according to differential drive kinematics.
5+
6+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_2/doc/userdoc.html).

example_3/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ros2_control_demo_example_3
2+
3+
*RRBot* with multiple interfaces.
4+
5+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_3/doc/userdoc.html).

example_4/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ros2_control_demo_example_4
2+
3+
*RRBot* with an integrated sensor.
4+
5+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_4/doc/userdoc.html).

example_5/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ros2_control_demo_example_5
2+
3+
*RRBot* with an externally connected sensor.
4+
5+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_5/doc/userdoc.html).

example_6/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ros2_control_demo_example_6
2+
3+
The example shows how to implement robot hardware with separate communication to each actuator.
4+
5+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_6/doc/userdoc.html).

example_8/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ros2_control_demo_example_8
2+
3+
*RRBot* with an exposed transmission interface.
4+
5+
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_8/doc/userdoc.html).

0 commit comments

Comments
 (0)