Skip to content

Commit

Permalink
Update docker README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jj7258 authored Sep 18, 2024
1 parent 34ecfa3 commit 99cf100
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,27 @@ NavRover is a ROS-based project designed for autonomous navigation. This reposit

To build the Docker image, navigate to the `docker` directory and run the following command:

./build_docker.sh

./build_docker.sh


This script will build the Docker image with the name `navrover`. Ensure that the build completes successfully.

## Running the Docker Container

To run the Docker container, execute the following command:


./run_docker.sh


This script will check for NVIDIA runtime availability and run the container accordingly, enabling GPU support if available.

### Environment Variables

- `DISPLAY`: Set to `:0` for X11 forwarding.
- `XDG_RUNTIME_DIR`: Set to `/tmp/runtime-root` for GUI applications.

## Entry Point

The entry point for the Docker container is defined in `entrypoint.sh`, which sets up the ROS environment and executes the command passed to the container.

0 comments on commit 99cf100

Please sign in to comment.