|
4 | 4 |
|
5 | 5 | This is a ROS 2 package for using C++ kinematics frameworks in the context of ROS 2 control. A kinematics interface is designed to allow ROS 2 controllers to control robots in Cartesian space. This package also contains a basic implementation of the interface using KDL. |
6 | 6 |
|
7 | | -## Build status |
| 7 | +## Contributing |
| 8 | +As an open-source project, we welcome each contributor, regardless of their background and experience. Pick a [PR](https://github.com/ros-controls/kinematics_interface/pulls) and review it, or [create your own](https://github.com/ros-controls/kinematics_interface/contribute)! |
| 9 | +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. |
8 | 10 |
|
9 | | -ROS2 Distro | Branch | Build status | Documentation | Released packages |
| 11 | +## Build status |
| 12 | +ROS2 Distro | Branch | Build status | Documentation | Package Build | |
10 | 13 | :---------: | :----: | :----------: | :-----------: | :---------------: |
11 | | -**Rolling** | [`master`](https://github.com/ros-controls/kinematics_interface/tree/master) | [](https://github.com/ros-controls/kinematics_interface/actions/workflows/rolling-binary-build.yml) <br /> [](https://github.com/ros-controls/kinematics_interface/actions/workflows/rolling-semi-binary-build.yml) | [API](http://docs.ros.org/en/rolling/p/kinematics_interface/) [API kdl](http://docs.ros.org/en/rolling/p/kinematics_interface_kdl/) | [kinematics_interface](https://index.ros.org/p/kinematics_interface/#rolling) |
12 | | -**Jazzy** | [`jazzy`](https://github.com/ros-controls/kinematics_interface/tree/jazzy) | [](https://github.com/ros-controls/kinematics_interface/actions/workflows/jazzy-binary-build.yml) <br /> [](https://github.com/ros-controls/kinematics_interface/actions/workflows/jazzy-semi-binary-build.yml) | [API](http://docs.ros.org/en/jazzy/p/kinematics_interface/) [API kdl](http://docs.ros.org/en/jazzy/p/kinematics_interface_kdl/) | [kinematics_interface](https://index.ros.org/p/kinematics_interface/#jazzy) |
13 | | -**Humble** | [`humble`](https://github.com/ros-controls/kinematics_interface/tree/humble) | [](https://github.com/ros-controls/kinematics_interface/actions/workflows/humble-binary-build.yml) <br /> [](https://github.com/ros-controls/kinematics_interface/actions/workflows/humble-semi-binary-build.yml) | [API](http://docs.ros.org/en/humble/p/kinematics_interface/) [API kdl](http://docs.ros.org/en/humble/p/kinematics_interface_kdl/) | [kinematics_interface](https://index.ros.org/p/kinematics_interface/#humble) |
14 | | - |
15 | | -### Explanation of different build types |
16 | | - |
17 | | -**NOTE**: There are three build stages checking current and future compatibility of the package. |
18 | | - |
19 | | -[Detailed build status](.github/workflows/README.md) |
20 | | - |
21 | | -1. Binary builds - against released packages (main and testing) in ROS distributions. Shows that direct local build is possible. |
22 | | - |
23 | | - Uses repos file: `$NAME$-not-released.<ros-distro>.repos` |
24 | | - |
25 | | -1. Semi-binary builds - against released core ROS packages (main and testing), but the immediate dependencies are pulled from source. |
26 | | - 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. |
| 14 | +**Rolling** | [`master`](https://github.com/ros-controls/kinematics_interface/tree/master) | [](https://github.com/ros-controls/kinematics_interface/actions/workflows/rolling-binary-build.yml) <br> [](https://github.com/ros-controls/kinematics_interface/actions/workflows/rolling-semi-binary-build.yml) <br> [](https://build.ros2.org/job/Rdev__kinematics_interface__ubuntu_noble_amd64/) | [API](http://docs.ros.org/en/rolling/p/kinematics_interface/) <br> [API kdl](http://docs.ros.org/en/rolling/p/kinematics_interface_kdl/) | [](https://build.ros2.org/job/Rbin_uN64__kinematics_interface__ubuntu_noble_amd64__binary/) |
| 15 | +**Jazzy** | [`jazzy`](https://github.com/ros-controls/kinematics_interface/tree/jazzy) | [](https://github.com/ros-controls/kinematics_interface/actions/workflows/jazzy-binary-build.yml) <br> [](https://github.com/ros-controls/kinematics_interface/actions/workflows/jazzy-semi-binary-build.yml) <br> [](https://build.ros2.org/job/Jdev__kinematics_interface__ubuntu_noble_amd64/) | [API](http://docs.ros.org/en/jazzy/p/kinematics_interface/) <br> [API kdl](http://docs.ros.org/en/jazzy/p/kinematics_interface_kdl/) | [](https://build.ros2.org/job/Jbin_uN64__kinematics_interface__ubuntu_noble_amd64__binary/) |
| 16 | +**Humble** | [`humble`](https://github.com/ros-controls/kinematics_interface/tree/humble) | [](https://github.com/ros-controls/kinematics_interface/actions/workflows/humble-binary-build.yml) <br> [](https://github.com/ros-controls/kinematics_interface/actions/workflows/humble-semi-binary-build.yml) <br> [](https://build.ros2.org/job/Hdev__kinematics_interface__ubuntu_jammy_amd64/) | [API](http://docs.ros.org/en/humble/p/kinematics_interface/) <br> [API kdl](http://docs.ros.org/en/humble/p/kinematics_interface_kdl/) | [](https://build.ros2.org/job/Hbin_uJ64__kinematics_interface__ubuntu_jammy_amd64__binary/) |
27 | 17 |
|
28 | | - Uses repos file: `$NAME$.repos` |
| 18 | +## Acknowledgements |
| 19 | +The project has received major contributions from companies and institutions [listed on control.ros.org](https://control.ros.org/rolling/doc/acknowledgements/acknowledgements.html) |
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?v=4&size=40){kind=avatar}
0 commit comments