Skip to content

Commit

Permalink
Move the Docker image build instructions to a nested README (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanie-eng authored Sep 30, 2024
1 parent 58a2bed commit 7f02ada
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 19 deletions.
19 changes: 0 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,22 +108,3 @@ ros2 launch exercise1-1 ur.launch.py

This should open an RViz window with the UR visible. It should look like this:
![RViz-with-UR](./images/ur-launch.png)

### Building the Docker Image

**For the purposes of the workshop, please use the image provided in [the lastest release](https://github.com/moveit/roscon24/releases).**
**Workshop attendees should skip these steps as they do not need to build the image if they use the provided release.**

These steps are here for reference only to build the Docker image and are not requried for and should not be done for the workshop itself.

Running the build script is a supported workshop activity.
Please proceed with building the Docker image only if you are certain of your understanding and are prepared to handle potential issues that may arise.

The build script requries `pv`: `sudo apt install pv`

To build the image, use the `docker/build.sh` script:

1. `cd` into this repository.
2. `docker/build.sh`

This will build the image, tag it as `roscon-2024-moveit2-workshop`, and save the image as a compressed tarball. The `docker/fetch` script can be used to uncompress and load this output.
18 changes: 18 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### Building the Docker Image

**For the purposes of the workshop, please use the image provided in [the lastest release](https://github.com/moveit/roscon24/releases).**
**Workshop attendees should skip these steps as they do not need to build the image if they use the provided release.**

These steps are here for reference only to build the Docker image and are not requried for and should not be done for the workshop itself.

Running the build script is a supported workshop activity.
Please proceed with building the Docker image only if you are certain of your understanding and are prepared to handle potential issues that may arise.

The build script requries `pv`: `sudo apt install pv`

To build the image, use the `docker/build.sh` script:

1. `cd` into this repository.
2. `docker/build.sh`

This will build the image, tag it as `roscon-2024-moveit2-workshop`, and save the image as a compressed tarball. The `docker/fetch` script can be used to uncompress and load this output.

0 comments on commit 7f02ada

Please sign in to comment.