Browse Source

Update docker instructions (#15)

* Update docker instructions
* Renamed Rviz2 to RViz2

Signed-off-by: Steve Pham <[email protected]>
Steve Pham 2 years ago
parent
commit
eba26ab88f
1 changed files with 12 additions and 4 deletions
  1. 12 4
      Docker/README.md

+ 12 - 4
Docker/README.md

@@ -30,9 +30,9 @@ The above command example tags specific commits for o3de, the ros2 gem, and the
 
 This will create a docker image named 'o3de_robot_vacuum_simulation' with the tag 'latest' that contains both the simulation launcher and the 
 navigation stack. It will also contain helper scripts that will launch either the simulation (LaunchSimulation.bash) or 
-the Rviz2 (LaunchNavStack.bash).
+the RViz2 (LaunchNavStack.bash).
 
-You can also create a separate docker image that only contains the navigation stack and Rviz2 by supplying the argument 
+You can also create a separate docker image that only contains the navigation stack and RViz2 by supplying the argument 
 ```IMAGE_TYPE``` and setting it to 'navstack':
 
 ```
@@ -61,12 +61,20 @@ Then launch the built simulation docker image with the following command
 docker run --rm --network="bridge" --gpus all -e DISPLAY=:1 -v /tmp/.X11-unix:/tmp/.X11-unix -it o3de_robot_vacuum_simulation:latest /data/workspace/LaunchSimulation.bash
 ```
 
-Once the simulation is up and running, launch the robot application docker image, which will bring up RViz to control the robot.
+Once the simulation is up and running, launch the navigation stack inside the simulation docker image, which will bring up RViz to control the robot.
 
 ```
-docker run --rm --network="bridge" --gpus all -e DISPLAY=:1 -v /tmp/.X11-unix:/tmp/.X11-unix -it o3de_robot_vacuum_navstack:latest /data/workspace/LaunchNavStack.bash
+docker run --rm --network="bridge" --gpus all -e DISPLAY=:1 -v /tmp/.X11-unix:/tmp/.X11-unix -it o3de_robot_vacuum_simulation:latest /data/workspace/LaunchNavStack.bash
+
+```
+
+If you created a separate docker image 'o3de_robot_vacuum_navstack:latest' which only contains the navigation stack and RViz2, you can launch it using that image, provided that the simulation docker image 'o3de_robot_vacuum_simulation' is running.
 
 ```
+docker run --rm --network="bridge" --gpus all -e DISPLAY=:1 -v /tmp/.X11-unix:/tmp/.X11-unix -it o3de_robot_vacuum_navstack:latest /data/workspace/LaunchNavStack.bash
+```
+
+
 
 Make sure to revoke access to the X server when the simulation ends.