Skip to content

Commit 94640d2

Browse files
committed
Add README to docs
1 parent d8243ff commit 94640d2

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Emscripten-Forge Documentation
2+
3+
Follow the instructions below to build the documentation locally.
4+
5+
1. Install `pixi` in your environment.
6+
7+
```bash
8+
micromamba install pixi -c conda-forge
9+
```
10+
11+
2. Build the documentation.
12+
13+
```bash
14+
pixi run docs-build -d _build
15+
16+
```
17+
18+
3. The generated documentation can be found in the `_build` directory. Use your favorite server.
19+
20+
```bash
21+
cd _build
22+
python -m http.server
23+
```

0 commit comments

Comments
 (0)