Skip to content

Commit 301686a

Browse files
authored
Enhance README with installation and ROS compatibility
Added installation instructions and updated ROS compatibility information.
1 parent 387f232 commit 301686a

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,8 @@
33

44
# Compass stack
55

6-
![ROS Package Index](https://img.shields.io/ros/v/noetic/compass)
7-
![ROS Package Index](https://img.shields.io/ros/v/jazzy/compass)
8-
![ROS Package Index](https://img.shields.io/ros/v/kilted/compass)
9-
![ROS Package Index](https://img.shields.io/ros/v/rolling/compass)
10-
116
This collection of packages provides support for working with azimuths in ROS.
127

13-
See [ros2 branch](tree/ros2) for ROS 2 version of this package.
14-
158
## Packages
169

1710
- [compass_msgs](compass_msgs): The message definitions.
@@ -20,6 +13,34 @@ See [ros2 branch](tree/ros2) for ROS 2 version of this package.
2013
- [magnetometer_compass](magnetometer_compass): Support and ROS nodes for extracting azimuths from 3-axis magnetometers.
2114
- [magnetometer_pipeline](magnetometer_pipeline): Calibration and removing of magnetometer bias.
2215

16+
## Installation
17+
18+
Install from commandline:
19+
20+
```bash
21+
sudo apt install ros-${ROS_DISTRO}-magnetometer-compass
22+
```
23+
24+
Or declare dependency in package.xml and let rosdep install:
25+
26+
```xml
27+
<exec_depend>magnetometer_compass</exec_depend>
28+
```
29+
30+
Code on [master branch](/github/ctu-vras/tree/master) is for ROS 1 and it has binary releases for Noetic. It can be built from source on Melodic.
31+
32+
![ROS 1 compatible](https://img.shields.io/badge/ROS-1-blue)
33+
![Melodic](https://img.shields.io/badge/ros%20|%20melodic-src-green)
34+
[![Noetic](https://img.shields.io/ros/v/noetic/compass)](https://index.ros.org/r/compass/#noetic)
35+
36+
Code on [ros2 branch](/github/ctu-vras/tree/ros2) is for ROS 2 Jazzy, Kilted and Rolling and has binary releases for all these distros.
37+
Humble, Iron and older ROS 2 distros are not supported.
38+
39+
![ROS 2 compatible](https://img.shields.io/badge/ROS-2-blue)
40+
[![Jazzy](https://img.shields.io/ros/v/jazzy/compass)](https://index.ros.org/r/compass/#jazzy)
41+
[![Kilted](https://img.shields.io/ros/v/kilted/compass)](https://index.ros.org/r/compass/#kilted)
42+
[![Rolling](https://img.shields.io/ros/v/rolling/compass)](https://index.ros.org/r/compass/#rolling)
43+
2344
## Definitions
2445

2546
**ENU** frame is the [standard orientation used in ROS](https://www.ros.org/reps/rep-0103.html). The abbreviation means

0 commit comments

Comments
 (0)