Skip to content

Commit 715fbaa

Browse files
committed
docs: make the two install/run commands the unmissable centerpiece of Run it
1 parent 307c269 commit 715fbaa

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -117,25 +117,24 @@ and agents, not just people) and captures the black-box rosbag you then open in
117117

118118
## Run it in 5 minutes
119119

120-
**Install** from the ROS 2 distribution (source build and Pixi in the
121-
[installation docs](https://selfpatch.github.io/ros2_medkit/installation.html)):
120+
**Two commands. No code changes, no config.** Install from the ROS 2 distribution, then launch
121+
it next to your already-running robot:
122122

123123
```bash
124-
sudo apt install ros-jazzy-ros2-medkit-gateway # or ros-humble-ros2-medkit-gateway
125-
```
126-
127-
The gateway package pulls in the fault manager and the drop-in bridges.
128-
129-
**Run it next to your robot** - one command attaches to your already-running ROS 2 graph
130-
(same `ROS_DOMAIN_ID` / RMW, no config) and starts the gateway, the fault manager and the
131-
generic fault bridges (`/rosout`, action status, `/diagnostics`):
124+
# 1. Install (the gateway package pulls in the fault manager + the drop-in bridges)
125+
sudo apt install ros-jazzy-ros2-medkit-gateway # or ros-humble-ros2-medkit-gateway
132126

133-
```bash
127+
# 2. Attach to your running ROS 2 graph - same ROS_DOMAIN_ID / RMW, nothing to configure
134128
ros2 launch ros2_medkit_gateway bringup.launch.py
135-
# REST API on http://localhost:8080/api/v1/
129+
# REST API live at http://localhost:8080/api/v1/
136130
```
137131

138-
**Use it - just curl the REST API** (no UI, no CORS):
132+
> [!TIP]
133+
> That is the whole setup. It auto-discovers every node, topic, service and action and starts
134+
> emitting structured faults over REST - no instrumentation, no changes to your stack. Prefer
135+
> source or Pixi? See the [installation docs](https://selfpatch.github.io/ros2_medkit/installation.html).
136+
137+
**Then just curl the REST API** (no UI, no CORS):
139138

140139
```bash
141140
# Your whole graph as a SOVD entity tree, instantly:

0 commit comments

Comments
 (0)