Skip to content

Commit 3e02f24

Browse files
committed
Update nav2_demo readme after introducing space_nav2_bringup package (#142).
1 parent ffda8ce commit 3e02f24

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

nav2_demo/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Start the space_nav2 container and launch the navigation2 nodes:
2222

2323
```
2424
./run.sh
25-
ros2 launch nav2_bringup navigation_launch.py use_sim_time:=True params_file:=nav2_params.yaml
25+
ros2 launch space_nav2_bringup navigation_launch.py use_sim_time:=True params_file:=nav2_params.yaml
2626
```
2727

2828
## Terminal 3 - launch localization with map
2929

3030
```
3131
docker exec -it osrf_space_nav2_demo bash
3232
source install/setup.bash
33-
ros2 launch nav2_bringup localization_launch.py use_sim_time:=True map:=mars_map.yaml
33+
ros2 launch space_nav2_bringup localization_launch.py use_sim_time:=True map:=mars_map.yaml params_file:=nav2_params.yaml
3434
```
3535

3636
## Terminal 4 - launch Rviz

navigation2/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ spaceros-user@ip-your-ip-address:/home/spaceros-user/nav2_ws#
5757

5858
To run the latest demo, see the README in the [nav2_demo](../nav2_demo/README.md) folder.
5959

60-
6160
## Updating navigation2 packages
61+
6262
The `navigation2.repos` file available in this repository provides a list of repos that are required to build the nav2 stack. ROS packages already included in the SpaceROS base image are omited from this file.
6363

6464
To update navigation2 packages used to build the space nav2 image, run the `docker_update_nav2_repos.sh` script:
@@ -69,5 +69,10 @@ To update navigation2 packages used to build the space nav2 image, run the `dock
6969

7070
This will update the `navigation2.repos` file with the newest versions of nav2 packages. The script resolves missing packages in base spaceros image and creates a list with their latest versions. The `navigation2.repos` file is then copied during build to the docker image with space nav2, and packages specified in the file are cloned and installed.
7171

72-
To generate a list of required packages for any other ROS workspace (e.g. your custom workspace built on top of SpaceROS that already has some nav2 dependencies installed), consider using the `update_nav2_repos.sh` as your starting point. You may also need to clone `generate-repos.sh` script from the main spaceros repository.
72+
By default, this update nav2 repositories using the latest released version of the Space ROS base image (typically `osrf/space-ros:latest`).
73+
If building locally, the underlying base image can be set in the through the environment with:
74+
```
75+
SPACE_ROS_IMAGE=osrf/space-ros:main ./docker_update_nav2_repos.sh
76+
```
7377

78+
To generate a list of required packages for any other ROS workspace (e.g. your custom workspace built on top of SpaceROS that already has some nav2 dependencies installed), consider using the `update_nav2_repos.sh` as your starting point. You may also need to clone `generate-repos.sh` script from the main spaceros repository.

0 commit comments

Comments
 (0)