Skip to content

Commit 9fb1c47

Browse files
committed
Update installation instructions in docs
1 parent 67fe5b1 commit 9fb1c47

File tree

2 files changed

+39
-4
lines changed

2 files changed

+39
-4
lines changed

ur_simulation_gz/doc/installation.rst

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,44 @@
33
Installation
44
============
55

6-
Skip any of below steps is not applicable.
6+
You can install the Universal Robots ROS2 GZ Simulation package in two ways:
7+
8+
1. **From binary packages**: This is the recommended way for most users, as it is quick and easy.
9+
2. **From source**: This is useful if you want to modify the code or if you require to have a
10+
version that is newer than the latest binary package available.
11+
12+
Installation from binary packages
13+
---------------------------------
14+
15+
1. `Install ROS2 <https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html>`_
16+
2. Install the package using
17+
18+
.. code-block:: bash
19+
20+
sudo apt-get install ros-${ROS_DISTRO}-ur-simulation-gz
21+
22+
That's it! You can now use the Universal Robots ROS2 GZ Simulation package in your ROS 2
23+
environment. See the :ref:`ur_simulation_gz_usage` section for how to use it.
24+
25+
26+
Installation from source
27+
------------------------
28+
29+
.. note::
30+
This section is only required if you want to build the package from source. Please do that
31+
only, if that's required for you. Reasons why you would need to build it from source are:
32+
33+
- You built one of multiple of this package's dependencies from source and want to use it with
34+
this package.
35+
- You want to develop this package or contribute to it. If you only want to modify the launch
36+
files to fit your application, a better approeach would be to create your own package with
37+
your own launch files that include the ones from this package.
38+
39+
To rather install the binary packages, please refer to the `Installation from binary
40+
packages`_ section above.
741

842
Setup ROS2 Workspace
9-
--------------------
43+
~~~~~~~~~~~~~~~~~~~~
1044

1145
1. Create a colcon workspace:
1246

@@ -30,11 +64,10 @@ Setup ROS2 Workspace
3064
3165
$ cd $COLCON_WS
3266
$ git clone -b ros2 https://github.com/UniversalRobots/Universal_Robots_ROS2_GZ_Simulation.git src/ur_simulation_gz
33-
$ vcs import --input src/ur_simulation_gz/ur_simulation_gz-not-released.rolling.repos src # only required for rolling
3467
$ rosdep update && rosdep install --ignore-src --from-paths src -y
3568
3669
Configure and build Workspace
37-
-----------------------------
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3871

3972
To configure and build the workspace execute following commands:
4073

ur_simulation_gz/doc/usage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:github_url: https://github.com/UniversalRobots/Universal_Robots_ROS2_GZ_Simulation/blob/ros2/ur_simulation_gz/doc/usage.rst
22

3+
.. _ur_simulation_gz_usage:
4+
35
Usage
46
=====
57

0 commit comments

Comments
 (0)