Skip to content

Commit 2f6de71

Browse files
Add tools/serve_web
1 parent 9edbf75 commit 2f6de71

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

tools/serve_web.cmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@echo off
2+
3+
python -m http.server -b 127.0.0.1 --directory web/output/html

tools/serve_web.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
python -m http.server -b 127.0.0.1 --directory web/output/html

web/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,24 @@ pip install -r requirements.txt
2626

2727
### Usage
2828

29-
The `wikigen.py` script is intended to be executed from the root of the repository.
29+
Depending on your operating system, you can run the following commands:
3030

31-
To build the repository, run `tools/build_web.sh` or `tools/build_web.cmd` depending on your operating system.
31+
#### Linux
3232

33-
To serve the repository locally, run the following command:
33+
```bash
34+
# Build the wiki website
35+
./tools/build_web.sh
36+
37+
# Serve the website locally
38+
./tools/serve_web.sh
39+
```
40+
41+
#### Windows
3442

3543
```bash
36-
python -m http.server -b 127.0.0.1 --directory web/output/html
44+
# Build the wiki website
45+
./tools/build_web.cmd
46+
47+
# Serve the website locally
48+
./tools/serve_web.cmd
3749
```

0 commit comments

Comments
 (0)