Skip to content

Commit 8b74992

Browse files
committed
README: Update build instructions
1 parent 0380d28 commit 8b74992

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,21 @@ kernel syscall implementation tracker.
2020
- Downloadable kernel configurations to build kernels with the same syscalls
2121
listed in the tables.
2222

23-
## How to build
23+
## Building
2424

25-
To build this static website, you need Python 3 with the `fonttools` and `brotli` modules.
26-
Then, you may execute in the root of this repository:
27-
```bash
25+
To build this static website, you will need Python 3, and optionally the
26+
`fonttools` and `brotli` modules. Run the following in the root of this
27+
repository:
28+
29+
```sh
30+
# Required: copies over db files and builds index
2831
./scripts/build_web_db.py
32+
# Opional: build emoji font (needs fonttools + brotli)
2933
./scripts/build_web_fonts.sh
3034
```
31-
The static website is now available in `www/` folder.
32-
You may quickly test the website using `python3 -m http.server -d www/`.
35+
36+
The static website is now available in `www/` folder. You may quickly test it
37+
locally using `python3 -m http.server -d www/`.
3338

3439
---
3540

0 commit comments

Comments
 (0)