From 43f2da67ac3c7a41083fcc92e9cab4fb42e3c944 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 20 Mar 2024 11:29:50 +0100 Subject: [PATCH] Add development version build instructions (#256) (#261) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit (cherry picked from commit ac8ad2ed003b0de0a949274f842f055d73b2d562) Co-authored-by: Christoph Fröhlich --- doc/getting_started/getting_started.rst | 47 +++++++++++++++++++------ 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/doc/getting_started/getting_started.rst b/doc/getting_started/getting_started.rst index f7d6c392274..8b9447028b9 100644 --- a/doc/getting_started/getting_started.rst +++ b/doc/getting_started/getting_started.rst @@ -15,21 +15,48 @@ To use it, you have to install ``ros-{DISTRO}-ros2-control`` and ``ros-{DISTRO}- Building from Source --------------------------- -.. raw:: html +To receive the latest features and bug fixes or if you want to contribute to the framework, you can build the framework from source. - - {DISTRO} Binary Build +You can choose between the following options: -If you want to install the framework from source, e.g., for contributing to the framework, use the following commands: + * Stable version: These branches will be released in the future in the respective ROS 2 distribution binaries. -* Download all repositories + .. raw:: html - .. code-block:: shell + + {DISTRO} Binary Build + + * Development version: We thrive to make the rolling development version (from the master branches) of the ros2_control stack compatible with earlier releases of ROS2. This is done by building the rolling version of the stack from source with the earlier releases of ROS2. + + .. raw:: html + + + Rolling Compatibility {DISTRO} + + .. tabs:: + + .. group-tab:: Stable version + + + * Download all repositories + + .. code-block:: shell + + mkdir -p ~/ros2_ws/src + cd ~/ros2_ws/ + wget https://raw.githubusercontent.com/ros-controls/ros2_control_ci/master/ros_controls.$ROS_DISTRO.repos + vcs import src < ros_controls.$ROS_DISTRO.repos + + .. group-tab:: Development version + + * Download all repositories + + .. code-block:: shell - mkdir -p ~/ros2_ws/src - cd ~/ros2_ws/ - wget https://raw.githubusercontent.com/ros-controls/control.ros.org/master/ros_controls.$ROS_DISTRO.repos - vcs import src < ros_controls.$ROS_DISTRO.repos + mkdir -p ~/ros2_ws/src + cd ~/ros2_ws/ + wget https://raw.githubusercontent.com/ros-controls/ros2_control_ci/master/ros_controls.rolling-on-$ROS_DISTRO.repos.repos + vcs import src < ros_controls.$ROS_DISTRO.repos * Install dependencies: