Skip to content

Commit b214ad1

Browse files
authored
Add Docker recommendation to Getting Started (#408) (#409)
1 parent 3477a55 commit b214ad1

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/tutorials/getting_started/getting_started.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ Getting Started
33

44
Here we will setup your environment for best running the tutorials. This will create a Colcon workspace, download all of the latest MoveIt source code, and build everything from source to ensure you have the latest fixes and improvements.
55

6+
Building all the source code of MoveIt can take 20-30 minutes, depending on the CPU speed and available RAM of your computer. If you are on a less performant system, or generally just want to get started quicker, checkout our :doc:`Docker Guide </doc/how_to_guides/how_to_setup_docker_containers_in_ubuntu>`.
7+
68
Install ROS 2 and Colcon
79
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
810
:ros_documentation:`Install ROS 2 {DISTRO_TITLE}<Installation.html>`.
@@ -42,7 +44,7 @@ For tutorials you will need to have a :ros_documentation:`colcon <Tutorials/Colc
4244

4345
Download Source Code of MoveIt and the Tutorials
4446
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45-
Move into your colcon workspace and pull the MoveIt tutorials source: ::
47+
Move into your Colcon workspace and pull the MoveIt tutorials source: ::
4648

4749
cd ~/ws_moveit2/src
4850
git clone https://github.com/ros-planning/moveit2_tutorials -b main
@@ -57,7 +59,7 @@ The following will install from Debian any package dependencies not already in y
5759

5860
rosdep install -r --from-paths . --ignore-src --rosdistro $ROS_DISTRO -y
5961

60-
The next command will configure your colcon workspace: ::
62+
The next command will configure your Colcon workspace: ::
6163

6264
cd ~/ws_moveit2
6365
colcon build --mixin release
@@ -69,7 +71,7 @@ If everything goes well, you should see the message "finished". If you have prob
6971
Setup Your Colcon Workspace
7072
^^^^^^^^^^^^^^^^^^^^^^^^^^^
7173

72-
Source the colcon workspace: ::
74+
Source the Colcon workspace: ::
7375

7476
source ~/ws_moveit2/install/setup.bash
7577

@@ -79,7 +81,7 @@ Optional: add the previous command to your ``.bashrc``: ::
7981

8082
.. note:: Sourcing the ``setup.bash`` automatically in your ``~/.bashrc`` is
8183
not required and often skipped by advanced users who use more than one
82-
colcon workspace at a time, but we recommend it for simplicity.
84+
Colcon workspace at a time, but we recommend it for simplicity.
8385

8486
Next Step
8587
^^^^^^^^^

0 commit comments

Comments
 (0)