Skip to content

Commit 19b6a79

Browse files
committed
docs: the installation page said binary packages do not exist yet
They have since 0.3.0, and the README already tells the reader to apt install the gateway. The page now leads with the apt path and names the three packages that genuinely are not in the index: opcua, graph_watchdog and fault_detection.
1 parent c635da2 commit 19b6a79

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

docs/installation.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,25 @@ for your distribution:
4141
vendored copy as a fallback - no manual installation is needed. The build system
4242
automatically uses the vendored header when the system package is insufficient.
4343

44+
Installation from Binary Packages
45+
---------------------------------
46+
47+
ros2_medkit is in the ROS index, so most packages install with ``apt``:
48+
49+
.. code-block:: bash
50+
51+
sudo apt install ros-jazzy-ros2-medkit-gateway # or ros-humble- / ros-lyrical-
52+
ros2 launch ros2_medkit_gateway bringup.launch.py
53+
54+
Three packages are not in the index yet and have to be built from source:
55+
``ros2_medkit_opcua``, which is waiting on open62541pp being vendored,
56+
``ros2_medkit_graph_watchdog``, and ``ros2_medkit_fault_detection``.
57+
4458
Installation from Source
4559
------------------------
4660

47-
ros2_medkit is currently distributed as source code. Binary packages will be available in future releases.
61+
Build from source to get every package, to run against an unreleased version, or
62+
to develop against the tree.
4863

4964
1. **Create a workspace**
5065

0 commit comments

Comments
 (0)