From 5d3f0189da4b27667106aba2b558f415bb0383ca Mon Sep 17 00:00:00 2001 From: David Conner Date: Tue, 15 Oct 2024 14:55:10 -0400 Subject: [PATCH 1/4] clarify start up instructions for those completely new to docker --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 38838c9..b651d95 100644 --- a/README.md +++ b/README.md @@ -57,28 +57,30 @@ docker compose --help ### Installation -First, clone this repository and its submodules. +First, open a terminal window and clone this repository and its submodules. ```bash git clone --recurse-submodules https://github.com/ros-wg-delib/roscon24-workshop.git ``` -Start the Docker container. -Note that this will pull the Docker image and may take a few minutes. +Change into the repository folder (`cd roscon24-workshop`) and start the Docker container. ```bash docker compose run base ``` -This will start the container and drop you into a bash shell. +> Note that this will initially download the Docker image and may take a few minutes +> for the download complete and the workspace to build. -Once you're in the container, check that you can launch a simulated world and the PyRoboSim UI appears on your screen. +After the container build finishes you will be in a bash shell. + +Verify that you can launch a simulated world and the PyRoboSim UI appears on your screen. ```bash ros2 run delib_ws_worlds run ``` -You can attach to the running container from a different console, using the command: +You can attach to the running container from a different terminal using the command: ```bash docker compose run base bash @@ -98,7 +100,7 @@ We have created handy aliases that effectively wrap around `colcon build --symli * `delib_build_packages_up_to ` - Builds all dependencies up to a specific package. * `delib_clean` - Cleans up the entire workspace. -When you are ready to shut down the container, enter the following command: +When you are ready to shut down the container, enter the following command from a terminal on your system: ```bash docker compose down --remove-orphans From bd8f2c65e19531c712409d5f30eb34cb761f2bac Mon Sep 17 00:00:00 2001 From: David Conner Date: Tue, 15 Oct 2024 15:01:43 -0400 Subject: [PATCH 2/4] wait for build to complete before opening new terminals --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b651d95..0f7e1c5 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ Verify that you can launch a simulated world and the PyRoboSim UI appears on you ros2 run delib_ws_worlds run ``` -You can attach to the running container from a different terminal using the command: +*After* the initial build completes, you can open new terminals and attach to the running container from a different terminal using the command: ```bash docker compose run base bash From 44bf6fe74561aedb282135d495d524f3b6faf4ad Mon Sep 17 00:00:00 2001 From: David Conner Date: Tue, 15 Oct 2024 21:39:37 -0400 Subject: [PATCH 3/4] use docker compose exec base bash --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0f7e1c5..632164c 100644 --- a/README.md +++ b/README.md @@ -80,12 +80,14 @@ Verify that you can launch a simulated world and the PyRoboSim UI appears on you ros2 run delib_ws_worlds run ``` -*After* the initial build completes, you can open new terminals and attach to the running container from a different terminal using the command: +*After* the initial build completes, you can open new terminals and attach to the currently running container from a different terminal using the command: ```bash -docker compose run base bash +docker compose exec base bash ``` +> Note: This command must be executed from the `roscon24-workshop` repository folder. + --- ## Developing in the Container From 128884bc79d9587b2fe749a87ed62e3ea0fc2455 Mon Sep 17 00:00:00 2001 From: David Conner Date: Wed, 16 Oct 2024 14:37:33 -0400 Subject: [PATCH 4/4] change problem 3 setup so pantry is closed to match description --- problems/delib_ws_worlds/worlds/world3.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/problems/delib_ws_worlds/worlds/world3.yaml b/problems/delib_ws_worlds/worlds/world3.yaml index 2c72947..c9d367d 100644 --- a/problems/delib_ws_worlds/worlds/world3.yaml +++ b/problems/delib_ws_worlds/worlds/world3.yaml @@ -200,7 +200,7 @@ locations: parent: kitchen category: storage pose: [-3.65, -1.5, 0.0, 1.57] - is_open: true + is_open: false - name: bin parent: office