Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
j3soon committed Sep 22, 2023
1 parent 863db53 commit d0ae2f1
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <IMAGE_NAME>` 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` |
12 changes: 10 additions & 2 deletions template_ws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.```.
Expand All @@ -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.
Expand Down

0 comments on commit d0ae2f1

Please sign in to comment.