Skip to content

Commit

Permalink
update readme to show use of pre-built images.
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartcaunt committed Jan 7, 2025
1 parent c15cd1e commit d2a5e98
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ docker build -t webx-dev-env-ubuntu:22.04 -f webx-dev-env-ubuntu-22.04.dockerfil

This generates a Docker image called `webx-dev-env-ubuntu:22.04`.

> Please note that all the docker images are available pre-built on ghcr.io as described below.
## Running a dev environment

The dev environment runs an Xfce4 desktop manager. For this to be useful for the WebX Engine development you need to:
Expand All @@ -34,6 +36,16 @@ docker run --rm -v `pwd`:/app -p 5555-5558:5555-5558 --name webx-dev-env webx-de

will run the display manager on DISPLAY :10 with a resolution of 2560x1440.

### Running a pre-built dev environment

All the dev environments are available to run directly from [ghcr.io](https://github.com/ILLGrenoble/webx-dev-env/packages).

To run a pre-built environment just prefix the image name specified above with `ghcr.io/illgrenoble/`. For example to run the ubuntu:22.04 image just type:

```
docker run --rm -v `pwd`:/app -p 5555-5558:5555-5558 --name webx-dev-env ghcr.io/illgrenoble/webx-dev-env-ubuntu:22.04
```

## Stopping the dev environment

To stop the dev environment container use `ctrl-c` if the container is running in the foreground. You can also stop the container by running
Expand Down

0 comments on commit d2a5e98

Please sign in to comment.