Skip to content

Commit 0c79d74

Browse files
committed
docs: improve install guide a bit
1 parent 682af92 commit 0c79d74

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

docs/installation.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Installation
22
============
33

4-
ROS2 installation is out of topic for that guide,
5-
you should follow the [official installation instruction][kinst].
4+
ROS2 installation is out of scope for this guide,
5+
you should follow the [official installation instructions][kinst].
66

77
!!! note
8-
This guide tested on the ROS2 **Kilted** release.
8+
This guide is tested on the ROS2 **Kilted** release.
99
But it is likely that your release will have quite similar set of commands.
1010

1111

@@ -30,7 +30,7 @@ ROS repository has binary packages for Ubuntu amd64 and aarch64.
3030
Just use `apt` for installation:
3131

3232
```shell
33-
sudo apt install ros-kilted-mavros
33+
sudo apt install ros-${ROS_DISTRO}-mavros
3434
```
3535

3636
Then install GeographicLib datasets using helper script:
@@ -65,7 +65,7 @@ cd ~/ros2_ws
6565
### Get MAVLink and MAVROS repos
6666
```shell
6767
rosinstall_generator --format repos mavlink | tee /tmp/mavlink.repos
68-
rosinstall_generator --format repos --upstream mavros | tee -a /tmp/mavros.repos
68+
rosinstall_generator --format repos --upstream mavros | tee /tmp/mavros.repos
6969
```
7070

7171
!!! note
@@ -86,6 +86,10 @@ rosdep update
8686
rosdep install --from-paths src --ignore-src -y
8787
```
8888

89+
!!! note
90+
If `rosdep update` fails due to permission issues in your environment, rerun it with `sudo`.
91+
92+
8993
### Install GeographicLib datasets
9094
```shell
9195
sudo ./src/mavros/scripts/install_geographiclib_datasets.sh
@@ -101,7 +105,12 @@ colcon build
101105
source ./install/setup.bash
102106
```
103107

104-
!!! node
108+
### Verify installation
109+
```shell
110+
ros2 pkg list | grep -E "^mavros$|^mavros_extras$|^mavros_msgs$"
111+
```
112+
113+
!!! note
105114
Make sure that you use `setup.bash` or `setup.zsh` from workspace.
106115
Otherwise `ros2 run` can't find nodes.
107116

@@ -112,7 +121,7 @@ Devcontainer (optional)
112121
You can use the provided devcontainer for a reproducible ROS 2 environment.
113122

114123
```shell
115-
cd ~/ros2/src/mavros
124+
cd ~/ros2_ws/src/mavros
116125
```
117126

118127
Open the folder in VS Code / VSCodium and run `Dev Containers: Reopen in Container`.

0 commit comments

Comments
 (0)