Skip to content

Commit f84f4e6

Browse files
authored
Update README with devcontainers usage instructions
Added instructions for using devcontainers and headless run.
1 parent 184703e commit f84f4e6

1 file changed

Lines changed: 38 additions & 18 deletions

File tree

README.md

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,39 +22,59 @@ A `development container` (or dev container for short) allows you to use a cont
2222
- Custom PS1 (terminal shell);
2323
</details>
2424

25-
## Devcontainers installation
25+
<div align="center">
26+
<img src="https://github.com/user-attachments/assets/6c085018-0b43-4f0e-9316-20bac5d0d4c1" alt="Fully loaded interface with the VNC client and multiple terminals on the bottom panel" style="text-align:center; width:70%">
27+
<br>
28+
Fully loaded interface with the VNC client and multiple terminals on the bottom panel.
29+
</div>
30+
31+
## How to use?
2632

33+
### To develop locally, using `devcontainers` (local VScode)
34+
35+
<details>
36+
<summary> Recommended for local development, with X11 sharing, etc.</summary>
37+
38+
- `git clone git@github.com:verlab/ros1_devcontainer_docker_compose.git`
39+
- Verify the compose file used in the container used in `.devcontainer/devcontaoiner.json`, given your operative system:
40+
```json
41+
"dockerComposeFile": [
42+
"../compose_linux_host.yaml" # or can be also "../compose_macos_host.yaml" if you use MacOS
43+
],
44+
```
2745
- Open folder with VScode using the dev containers plugin (https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
46+
- `control + shift + p`
47+
- Write `Dev Containers: Reopen in Container` or `Dev Containers: Rebuild and Reopen in Container`
2848

29-
## Quick usage
49+
<div align="center">
50+
<img src="https://github.com/user-attachments/assets/784b06f7-8225-4be8-a2b7-e6e96b8cc376" alt="Fully loaded interface with the VNC client and multiple terminals on the bottom panel" style="text-align:center; width:70%">
51+
<br>
52+
How to open the repo using the Dev Containers plugin in VScode.
53+
</div>
54+
</details>
3055

31-
### Start devcontainer on VScode or use `docker compose`
3256

33-
- When the host is a linux-based machine:
34-
```
35-
BUILDKIT_PROGRESS=plain docker compose -f compose_linux_host.yaml up --build
36-
```
57+
### Headless run with `docker compose` (remote Jetson headless)
3758

38-
- When the host is a macos-based machine:
39-
```
40-
BUILDKIT_PROGRESS=plain docker compose -f compose_macos_host.yaml up --build
41-
```
59+
<details>
60+
<summary>Recommended for remote development, as for example, deploying a dev machine on the robot.</summary>
61+
62+
- `git clone git@github.com:verlab/ros1_devcontainer_docker_compose.git`
63+
- `cd ros1_devcontainer_docker_compose`
64+
- `BUILDKIT_PROGRESS=plain docker compose -f compose_jetson_host.yaml up --build`
4265

4366
`BUILDKIT_PROGRESS=plain` helps to visualize step by step output of each of the commands.
67+
</details>
4468

45-
### Usage
69+
### Access to services
70+
71+
Once the container is up, the you can access the services via:
4672

4773
- VNC: http://localhost:3080
4874
- VScode: http://localhost:3081
4975
- SSH: `ssh ubuntu@localhost -p 3022`
5076
- user: `ubuntu`
5177
- pass: `ubuntu`
52-
53-
<div align="center">
54-
<img src="https://github.com/user-attachments/assets/6c085018-0b43-4f0e-9316-20bac5d0d4c1" alt="Fully loaded interface with the VNC client and multiple terminals on the bottom panel" style="text-align:center; width:70%">
55-
<br>
56-
Fully loaded interface with the VNC client and multiple terminals on the bottom panel.
57-
</div>
5878

5979
## Know issues
6080

0 commit comments

Comments
 (0)