Skip to content

Commit e4fcf58

Browse files
authored
readme: add explanation of mdbook commands, remove broken link to previous version
1 parent 566c5ca commit e4fcf58

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# GB ASM tutorial (v2)
1+
# GB ASM tutorial
22

3-
Re-doing [GB ASM Tutorial](https://github.com/ISSOtm/gb-asm-tutorial-old), and this time, until the end.
3+
A book that teaches how to develop games for the Game Boy and Game Boy Color using assembly language and the RGBDS toolchain.
44

5-
## Translating
6-
7-
To help translate the tutorial, join the [project on Crowdin](https://crowdin.com/project/gb-asm-tutorial).
5+
You can read it at https://gbdev.io/gb-asm-tutorial/.
86

97
## Contributing
108

@@ -17,9 +15,22 @@ To deploy gb-asm-tutorial locally:
1715
```bash
1816
$ cargo install mdbook@0.4.52
1917
```
20-
2. Within a terminal pointed at the directory `book.toml` is in, run mdBook (`mdbook build` / `mdbook watch` / `mdbook serve`).
21-
3. The HTML files are in `book/custom/`.
18+
2. Within a terminal pointed at the directory `book.toml` is in, run mdBook commands:
19+
20+
```bash
21+
# Watches the book's src directory for changes, rebuild the book, serve it on localhost:3000
22+
# and refresh clients for each change.
23+
mdbook serve
2224

25+
# Produce a build in `book/custom/`
26+
mdbook build
27+
# Watch your files and trigger a build automatically whenever you modify a file.
28+
mdbook watch
29+
```
30+
31+
## Translating
32+
33+
To help translate the tutorial, join the [project on Crowdin](https://crowdin.com/project/gb-asm-tutorial).
2334

2435
## License
2536

0 commit comments

Comments
 (0)