Skip to content

Commit 8242522

Browse files
Update README.md to be consistent within ros-controls (#764)
1 parent a9eed87 commit 8242522

File tree

6 files changed

+10
-202
lines changed

6 files changed

+10
-202
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/good-first-issue.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## General
2-
Please consider the guidelines from [CONTRIBUTING.md](CONTRIBUTING.md) before you open a pull request.
2+
Please consider the guidelines from [CONTRIBUTING.md](https://github.com/ros-controls/.github/blob/master/CONTRIBUTING.md) before you open a pull request.
33

44
## New Examples
55
If you propose adding a new example, make sure that your new example has:

CONTRIBUTING.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

README.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ It consists of simple implementations that demonstrate different concepts. Choos
77

88
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.
99

10+
## Contributing
11+
As an open-source project, we welcome each contributor, regardless of their background and experience. Pick a [PR](https://github.com/ros-controls/ros2_control_demos/pulls) and review it, or [create your own](https://github.com/ros-controls/ros2_control_demos/contribute)!
12+
If you are new to the project, please read the [contributing guide](https://control.ros.org/rolling/doc/contributing/contributing.html) for more information on how to get started. We are happy to help you with your first contribution.
13+
1014
## Getting Started
1115

1216
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.
1317

14-
1518
## Content
1619

1720
The following examples are part of this demo repository:
@@ -114,22 +117,9 @@ Those two world-known imaginary robots are trivial simulations to demonstrate an
114117

115118
ROS 2 Distro | Branch | Build status | Documentation
116119
:----------: | :----: | :----------: | :-----------:
117-
**Rolling** | [`master`](https://github.com/ros-controls/ros2_control_demos/tree/master) | [![Rolling Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml?branch=master) <br /> [![Rolling Semi-Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml?branch=master) <br /> | [Documentation](https://control.ros.org/master/index.html) <br /> [API Reference](https://control.ros.org/master/doc/api/index.html)
118-
**Jazzy** | [`master`](https://github.com/ros-controls/ros2_control_demos/tree/master) | [![Rolling Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml?branch=master) <br /> [![Rolling Semi-Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml?branch=master) <br /> | [Documentation](https://control.ros.org/master/index.html) <br /> [API Reference](https://control.ros.org/jazzy/doc/api/index.html)
119-
**Humble** | [`humble`](https://github.com/ros-controls/ros2_control_demos/tree/humble) | [![Humble Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-binary-build.yml/badge.svg?branch=humble)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-binary-build.yml?branch=humble) <br /> [![Humble Semi-Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-semi-binary-build.yml/badge.svg?branch=humble)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-semi-binary-build.yml?branch=humble) <br /> | [Documentation](https://control.ros.org/humble/index.html) <br />[API Reference](https://control.ros.org/humble/doc/api/index.html)
120-
121-
122-
### Explanation of different build types
123-
124-
**NOTE**: There are three build stages checking current and future compatibility of the package.
125-
126-
1. Binary builds - against released packages (main and testing) in ROS distributions. Shows that direct local build is possible.
127-
128-
Uses repos file: `src/$NAME$/$NAME$-not-released.<ros-distro>.repos`
129-
130-
1. Semi-binary builds - against released core ROS packages (main and testing), but the immediate dependencies are pulled from source.
131-
Shows that local build with dependencies is possible and if fails there we can expect that after the next package sync we will not be able to build.
132-
133-
Uses repos file: `src/$NAME$/$NAME$.repos`
120+
**Rolling** | [`master`](https://github.com/ros-controls/ros2_control_demos/tree/master) | [![Rolling Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml?branch=master) <br> [![Rolling Semi-Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml?branch=master) <br> | [Documentation](https://control.ros.org/master/index.html) <br> [API Reference](https://control.ros.org/master/doc/api/index.html)
121+
**Jazzy** | [`master`](https://github.com/ros-controls/ros2_control_demos/tree/master) | [![Rolling Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-binary-build.yml?branch=master) <br> [![Rolling Semi-Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml/badge.svg?branch=master)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/rolling-semi-binary-build.yml?branch=master) <br> | [Documentation](https://control.ros.org/master/index.html) <br> [API Reference](https://control.ros.org/jazzy/doc/api/index.html)
122+
**Humble** | [`humble`](https://github.com/ros-controls/ros2_control_demos/tree/humble) | [![Humble Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-binary-build.yml/badge.svg?branch=humble)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-binary-build.yml?branch=humble) <br> [![Humble Semi-Binary Build](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-semi-binary-build.yml/badge.svg?branch=humble)](https://github.com/ros-controls/ros2_control_demos/actions/workflows/humble-semi-binary-build.yml?branch=humble) <br> | [Documentation](https://control.ros.org/humble/index.html) <br>[API Reference](https://control.ros.org/humble/doc/api/index.html)
134123

135-
1. Source build - also core ROS packages are build from source. It shows potential issues in the mid future.
124+
## Acknowledgements
125+
The project has received major contributions from companies and institutions [listed on control.ros.org](https://control.ros.org/rolling/doc/acknowledgements/acknowledgements.html)

0 commit comments

Comments
 (0)