Skip to content

Commit bf371a6

Browse files
authored
Update README.md to be consistent within ros-controls (#320) (#337)
1 parent 364f7ce commit bf371a6

File tree

2 files changed

+11
-83
lines changed

2 files changed

+11
-83
lines changed

CONTRIBUTING.md

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

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,20 @@ control_toolbox
44
[![Licence](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
55
[![codecov](https://codecov.io/gh/ros-controls/control_toolbox/branch/humble/graph/badge.svg?token=0o4dFzADHj)](https://codecov.io/gh/ros-controls/control_toolbox/tree/humble)
66

7-
This package contains several C++ classes useful in writing controllers.
7+
This package contains several C++ classes and filter plugins useful in writing controllers.
88

99
See the documentation of [ros2_control](http://control.ros.org) and release infos on [index.ros.org](http://index.ros.org/p/control_toolbox).
1010

11+
## Contributing
12+
As an open-source project, we welcome each contributor, regardless of their background and experience. Pick a [PR](https://github.com/ros-controls/control_toolbox/pulls) and review it, or [create your own](https://github.com/ros-controls/control_toolbox/contribute)!
13+
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.
14+
1115
## Build status
12-
ROS2 Distro | Branch | Build status | Documentation | Released packages
16+
ROS2 Distro | Branch | Build status | Documentation | Package build
1317
:---------: | :----: | :----------: | :-----------: | :---------------:
14-
**Rolling** | [`ros2-master`](https://github.com/ros-controls/control_toolbox/tree/ros2-master) | [![Binary Build](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-binary.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-binary.yml?branch=ros2-master) <br /> [![Source Build](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-source.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-source.yml?branch=ros2-master) | [API](http://docs.ros.org/en/rolling/p/control_toolbox/) | [control_toolbox](https://index.ros.org/p/control_toolbox/#rolling)
15-
**Jazzy** | [`jazzy`](https://github.com/ros-controls/control_toolbox/tree/jazzy) | [![Jazzy Binary Build](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-binary.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-binary.yml?branch=ros2-master) <br /> [![Jazzy Source Build](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-source.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-source.yml?branch=ros2-master) | [API](http://docs.ros.org/en/jazzy/p/control_toolbox/) | [control_toolbox](https://index.ros.org/p/control_toolbox/#jazzy)
16-
**Humble** | [`humble`](https://github.com/ros-controls/control_toolbox/tree/humble) | [![Humble Binary Build](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-binary.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-binary.yml?branch=ros2-master) <br /> [![Humble Source Build](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-source.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-source.yml?branch=ros2-master) | [API](http://docs.ros.org/en/humble/p/control_toolbox/) | [control_toolbox](https://index.ros.org/p/control_toolbox/#humble)
17-
18-
## Publication
19-
20-
If you find this work useful please give credits to the authors by citing:
21-
22-
* S. Chitta, E. Marder-Eppstein, W. Meeussen, V. Pradeep, A. Rodríguez Tsouroukdissian, J. Bohren, D. Coleman, B. Magyar, G. Raiola, M. Lüdtke and E. Fernandez Perdomo
23-
**"ros_control: A generic and simple control framework for ROS"**,
24-
The Journal of Open Source Software, 2017. ([PDF](http://www.theoj.org/joss-papers/joss.00456/10.21105.joss.00456.pdf))
18+
**Rolling** | [`ros2-master`](https://github.com/ros-controls/control_toolbox/tree/ros2-master) | [![Binary Build](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-binary.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-binary.yml?branch=ros2-master) <br> [![Source Build](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-source.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/rolling-build-source.yml?branch=ros2-master) <br> [![build.ros2.org](https://build.ros2.org/buildStatus/icon?job=Rdev__control_toolbox__ubuntu_noble_amd64&subject=build.ros2.org)](https://build.ros2.org/job/Rdev__control_toolbox__ubuntu_noble_amd64/) | [API](http://docs.ros.org/en/rolling/p/control_toolbox/) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Rbin_uN64__realtime_tools__ubuntu_noble_amd64__binary)](https://build.ros2.org/job/Rbin_uN64__realtime_tools__ubuntu_noble_amd64__binary/)
19+
**Jazzy** | [`jazzy`](https://github.com/ros-controls/control_toolbox/tree/jazzy) | [![Jazzy Binary Build](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-binary.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-binary.yml?branch=ros2-master) <br> [![Jazzy Source Build](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-source.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/jazzy-build-source.yml?branch=ros2-master) <br> [![build.ros2.org](https://build.ros2.org/buildStatus/icon?job=Jdev__control_toolbox__ubuntu_noble_amd64&subject=build.ros2.org)](https://build.ros2.org/job/Jdev__control_toolbox__ubuntu_noble_amd64/) | [API](http://docs.ros.org/en/jazzy/p/control_toolbox/) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Jbin_uN64__realtime_tools__ubuntu_noble_amd64__binary)](https://build.ros2.org/job/Jbin_uN64__realtime_tools__ubuntu_noble_amd64__binary/)
20+
**Humble** | [`humble`](https://github.com/ros-controls/control_toolbox/tree/humble) | [![Humble Binary Build](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-binary.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-binary.yml?branch=ros2-master) <br> [![Humble Source Build](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-source.yml/badge.svg?branch=ros2-master)](https://github.com/ros-controls/control_toolbox/actions/workflows/humble-build-source.yml?branch=ros2-master) <br> [![build.ros2.org](https://build.ros2.org/buildStatus/icon?job=Hdev__control_toolbox__ubuntu_jammy_amd64&subject=build.ros2.org)](https://build.ros2.org/job/Hdev__control_toolbox__ubuntu_jammy_amd64/) | [API](http://docs.ros.org/en/humble/p/control_toolbox/) | [![Build Status](https://build.ros2.org/buildStatus/icon?job=Hbin_uJ64__realtime_tools__ubuntu_jammy_amd64__binary)](https://build.ros2.org/job/Hbin_uJ64__realtime_tools__ubuntu_jammy_amd64__binary/)
2521

26-
```
27-
@article{ros_control,
28-
author = {Chitta, Sachin and Marder-Eppstein, Eitan and Meeussen, Wim and Pradeep, Vijay and Rodr{\'i}guez Tsouroukdissian, Adolfo and Bohren, Jonathan and Coleman, David and Magyar, Bence and Raiola, Gennaro and L{\"u}dtke, Mathias and Fern{\'a}ndez Perdomo, Enrique},
29-
title = {ros\_control: A generic and simple control framework for ROS},
30-
journal = {The Journal of Open Source Software},
31-
year = {2017},
32-
doi = {10.21105/joss.00456},
33-
URL = {http://www.theoj.org/joss-papers/joss.00456/10.21105.joss.00456.pdf}
34-
}
35-
```
22+
## Acknowledgements
23+
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)