Skip to content

Commit 151a96d

Browse files
committed
Update README with docker information
1 parent 6212faf commit 151a96d

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ You can read it at https://gbdev.io/gb-asm-tutorial/.
88

99
Contributing is really easy, fork this repo and edit the files in the **src** directory. Then, you can send your PR.
1010

11+
### Deploy Locally
12+
1113
To deploy gb-asm-tutorial locally:
1214

1315
1. Install [Rust](https://www.rust-lang.org/tools/install) and [mdBook](https://github.com/rust-lang/mdBook#readme) (v0.4.x).
@@ -28,6 +30,27 @@ mdbook build
2830
mdbook watch
2931
```
3032

33+
### Deploy with Docker
34+
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:
42+
43+
```sh
44+
docker run -p 3000:3000 \
45+
--mount "type=bind,source=$(pwd)/preproc,target=/code/preproc" \
46+
--mount "type=bind,source=$(pwd)/renderer,target=/code/renderer" \
47+
--mount "type=bind,source=$(pwd)/src,target=/code/src" \
48+
--mount "type=bind,source=$(pwd)/theme,target=/code/theme" \
49+
-it gb-asm-tutorial
50+
```
51+
52+
That's it! gb-asm-tutorial is live at [localhost:3000](https://localhost:3000).
53+
3154
## Translating
3255

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

0 commit comments

Comments
 (0)