Skip to content

Commit 7bba178

Browse files
committed
Update Readme
Signed-off-by: Alberto Tudela <[email protected]>
1 parent 16d8d83 commit 7bba178

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Overview
99

10-
Implementation of differents algorithms for segmentation of laserscans, splitting them into subsets of beams, with a ROS2 interface. The currently implemented algorithm are:
10+
Implementation of different algorithms for segmentation of laserscans, splitting them into subsets of beams, with a ROS2 interface. The currently implemented algorithm are:
1111

1212
* **`Jump distance clustering:`** widely used method for 2D laser range data in mobile robotics. It's a simple and fast method to segment the scans: if the Euclidean distance between two adjacent beams exceeds a given threshold distance, a new segment is generated.
1313
* **`Jump distance clustering and merge:`** Similar algorithm as above but checks if pre-predecessor segments are close to each other. This deals with over-segmented data with many small cluster in outdoor environment. It uses the same threshold condition twice.
@@ -28,6 +28,15 @@ The laser_segmentation package has been tested under [ROS2] Jazzy on [Ubuntu] 24
2828

2929
## Installation
3030

31+
### Binaries
32+
33+
On Ubuntu 24.04 you can install the latest version of this package using the following command
34+
35+
```bash
36+
sudo apt-get update
37+
sudo apt-get install ros-jazzy-laser-segmentation
38+
```
39+
3140
### Building from Source
3241

3342
#### Dependencies
@@ -39,16 +48,21 @@ The laser_segmentation package has been tested under [ROS2] Jazzy on [Ubuntu] 24
3948

4049
To build from source, clone the latest version from the main repository into your colcon workspace and compile the package using
4150

42-
cd colcon_workspace/src
43-
git clone https://github.com/ajtudela/laser_segmentation.git -b jazzy
44-
cd ../
45-
rosdep install -i --from-path src --rosdistro jazzy -y
46-
colcon build --symlink-install
51+
```bash
52+
cd colcon_workspace/src
53+
git clone https://github.com/ajtudela/laser_segmentation.git -b jazzy
54+
cd ../
55+
rosdep install -i --from-path src --rosdistro jazzy -y
56+
colcon build --symlink-install
57+
```
4758

4859
## Usage
4960

5061
With some scan source running, run the laser_segmentation node with:
51-
ros2 launch laser_segmentation segmentation.launch.py
62+
63+
```bash
64+
ros2 launch laser_segmentation segmentation.launch.py
65+
```
5266

5367
## Nodes
5468

0 commit comments

Comments
 (0)