Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify start up instructions for those completely new to docker #69

Merged
merged 6 commits into from
Oct 17, 2024
Merged

clarify start up instructions for those completely new to docker #69

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5d3f018
clarify start up instructions for those completely new to docker
Oct 15, 2024
bd8f2c6
wait for build to complete before opening new terminals
Oct 15, 2024
2233182
Merge branch 'main' into clarify-startup
Oct 16, 2024
44bf6fe
use docker compose exec base bash
Oct 16, 2024
128884b
change problem 3 setup so pantry is closed to match description
Oct 16, 2024
e787f98
Merge branch 'main' into clarify-startup
Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
*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
Copy link
Contributor

@sea-bass sea-bass Oct 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't notice this before, but doing docker compose run base, this actually creates a new container instead of attaching to the one that was just started.

So we actually want to do this to attach to the existing container.

docker compose exec base bash

You can verify the difference by typing docker ps.

Expand All @@ -98,7 +100,7 @@ We have created handy aliases that effectively wrap around `colcon build --symli
* `delib_build_packages_up_to <package>` - 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
Expand Down
Loading