Skip to content

Commit c3ade77

Browse files
committed
add readme docs
1 parent f531a6b commit c3ade77

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Create a new venv, and install the requirements file
2+
3+
4+
Then run the following to compile the docs
5+
6+
7+
```bash
8+
make dirhtml
9+
```
10+
11+
you can verify the updates by running the following command
12+
13+
```bash
14+
python -m http.server --directory _build/dirhtml
15+
```
16+

0 commit comments

Comments
 (0)