Skip to content

Commit 8d588f3

Browse files
committed
improve readme instructions
1 parent 7f1b232 commit 8d588f3

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# mqtt_client
22

33
<p align="center">
4-
<img src="https://img.shields.io/badge/ROS1-noetic-green"/></a>
54
<img src="https://img.shields.io/github/v/release/ika-rwth-aachen/mqtt_client"/></a>
65
<img src="https://img.shields.io/github/license/ika-rwth-aachen/mqtt_client"/></a>
76
<a href="https://github.com/ika-rwth-aachen/mqtt_client/actions/workflows/build.yml"><img src="https://github.com/ika-rwth-aachen/mqtt_client/actions/workflows/build.yml/badge.svg"/></a>
7+
<img src="https://img.shields.io/badge/ROS-noetic-blueviolet"/>
8+
<img src="https://img.shields.io/badge/ROS 2-humble|rolling-blueviolet"/>
89
<a href="https://github.com/ika-rwth-aachen/mqtt_client"><img src="https://img.shields.io/github/stars/ika-rwth-aachen/mqtt_client?style=social"/></a>
910
</p>
1011

@@ -23,21 +24,26 @@ The *mqtt_client* package provides a ROS nodelet or ROS 2 node that enables conn
2324

2425
## Installation
2526

26-
The *mqtt_client* package is released as an official ROS Noetic package and can easily be installed via a package manager.
27+
The *mqtt_client* package is released as an official ROS / ROS 2 package and can easily be installed via a package manager.
2728

2829
```bash
29-
# ROS 1
30-
sudo apt install ros-noetic-mqtt-client
31-
32-
# ROS 2
33-
sudo apt install ros-humble-mqtt-client
30+
sudo apt update
31+
sudo apt install ros-$ROS_DISTRO-mqtt-client
3432
```
3533

3634
If you would like to install *mqtt_client* from source, simply clone this repository into your ROS workspace. All dependencies that are listed in the ROS [`package.xml`](package.xml) can be installed using [*rosdep*](http://wiki.ros.org/rosdep).
3735

3836
```bash
3937
# mqtt_client$
4038
rosdep install -r --ignore-src --from-paths .
39+
40+
# ROS 1
41+
# workspace$
42+
catkin build -DCMAKE_BUILD_TYPE=Release mqtt_client
43+
44+
# ROS 2
45+
# workspace$
46+
colcon build --packages-up-to mqtt_client --cmake-args -DCMAKE_BUILD_TYPE=Release
4147
```
4248

4349
## Usage
@@ -217,7 +223,7 @@ broker:
217223
218224
```yaml
219225
client:
220-
id: # unique ID used to identify the client (broker may allow empty ID and automatically generate one)
226+
id: # unique ID string used to identify the client (broker may allow empty ID and automatically generate one)
221227
buffer:
222228
size: # [0] maximum number of messages buffered by the bridge when not connected to broker (only available if client ID is not empty)
223229
directory: # [buffer] directory used to buffer messages when not connected to broker (relative to ROS_HOME)

0 commit comments

Comments
 (0)