From d0ae2f12f8cb11e08cee943bbcd80c8746d3c533 Mon Sep 17 00:00:00 2001 From: Johnson Sun Date: Fri, 22 Sep 2023 17:10:22 +0800 Subject: [PATCH] Update README --- README.md | 10 ++++++++++ template_ws/README.md | 12 ++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 322e822a..e55e54b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # ROS 2 AGV Essentials A repo containing essential ROS2 features for controlling Autonomous Guided Vehicles (AGVs). + +## Pre-built Docker Images + +The following Docker images can be pulled by `docker pull ` or by `docker-compose pull` in the corresponding directory. + +Pulling the pre-built Docker images can bypass the time-consuming building process (for both docker-compose & devcontainers). + +| Docker Image | Description | +|--------------|-------------| +| [j3soon/ros2-template-ws](https://hub.docker.com/repository/docker/j3soon/ros2-template-ws/tags) | `./template_ws` | diff --git a/template_ws/README.md b/template_ws/README.md index 820c94b2..dfaf50cb 100644 --- a/template_ws/README.md +++ b/template_ws/README.md @@ -40,9 +40,13 @@ Copy the ```template_ws``` directory and follow the instructions below. Ensure you update the folder name ( ```template_ws``` ) after copying the folder immediately. -### 1. Configure the ```devcontainer.json``` +### 1. Configure `devcontainer` -> File path : ```.devcontainer/devcontainer.json``` +> File paths: +> - ```.devcontainer/devcontainer.json``` +> - ```docker/docker-compose.yaml``` + +> TODO: Update the instructions below for docker-compose. - Update the ```"name"``` to match your project. - Verify that the ```"runArg"``` matches your requirements. @@ -83,6 +87,8 @@ sudo apt-get update && apt-get install -y \ Spotting the workspace folder within your Explorer indicates that you've selected the wrong folder. You should only observe the ```.devcontainer``` and ```src``` folders there. +**Note**: Alternatively, you can use `docker-compose` instead of `devcontainers` if you are not using VSCode. + ### 4. Build the container Press ```F1``` and enter ```> Dev Containers: Rebuild Container.```. @@ -94,6 +100,8 @@ You should see the output below. Done. Press any key to close the terminal. ``` +**Note**: To save time, you can pull the pre-built Docker images instead of building them from scratch. + ### 5. Start to develop with ROS You've successfully completed all the instructions.