diff --git a/docker/README.md b/docker/README.md index 769b2f7..2c5b25d 100644 --- a/docker/README.md +++ b/docker/README.md @@ -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.