Skip to content

Commit

Permalink
write docker setup at readme (#57)
Browse files Browse the repository at this point in the history
* write docker setup at readme

Co-authored-by: Ryan <[email protected]>
  • Loading branch information
avcuenes and Ryanf55 authored Jan 20, 2024
1 parent 23141e4 commit 92dbada
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,41 @@ Build the package
```
colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to grid_map_geo
```
## Docker Setup

If your operating system doesn't support ROS 2 humble, docker is a great alternative.

First of all, you have to build the project and create an image like so:

```bash
## Assuimg you are in the correct project directory
docker build -t gmg .
```
To use a shortcut, you may use the following command:

```bash
## Assuimg you are in the correct project directory
make docker_build
```

After the image is created, copy and paste the following command to the terminal to run the image:

```bash
## Assuimg you are in the correct project directory
docker run -it --net=host --ipc=host --privileged --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" --volume="${XAUTHORITY}:/root/.Xauthority" --entrypoint /bin/bash gmg
```
To use a shortcut, you may use following command:

```bash
make docker_run
```
## Running the package at docker image

If you are in the docker image , this project is already sourced and the default launch file can be run as the following command;

```bash
ros2 launch grid_map_geo load_tif_launch.xml
```

## Running the package

Expand Down

0 comments on commit 92dbada

Please sign in to comment.