Skip to content

Commit efef11c

Browse files
committed
docs: explain how to use the ghcr image (#181)
1 parent f1abdf9 commit efef11c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,25 @@ mdbook watch
3232

3333
#### Using Docker
3434

35-
If you have [Docker installed](https://docs.docker.com/engine/install/), you can build the Docker image with:
36-
37-
```sh
38-
docker build -t gb-asm-tutorial .
39-
```
40-
41-
Then run the image with:
35+
If you have [Docker installed](https://docs.docker.com/engine/install/), you can pull and run the prebuilt image for this project:
4236

4337
```sh
4438
docker run -p 3000:3000 \
4539
--mount "type=bind,source=$(pwd)/preproc,target=/code/preproc" \
4640
--mount "type=bind,source=$(pwd)/renderer,target=/code/renderer" \
4741
--mount "type=bind,source=$(pwd)/src,target=/code/src" \
4842
--mount "type=bind,source=$(pwd)/theme,target=/code/theme" \
49-
-it gb-asm-tutorial
43+
-it ghcr.io/gbdev/gb-asm-tutorial
5044
```
5145

5246
That's it! gb-asm-tutorial is live at [localhost:3000](https://localhost:3000).
5347

48+
If you prefer to build the image yourself:
49+
50+
```sh
51+
docker build -t gb-asm-tutorial .
52+
```
53+
5454
## Translating
5555

5656
To help translate the tutorial, join the [project on Crowdin](https://crowdin.com/project/gb-asm-tutorial).

0 commit comments

Comments
 (0)