diff options
author | msunet <msunet@shellblade.net> | 2021-12-03 20:34:05 -0800 |
---|---|---|
committer | msunet <msunet@shellblade.net> | 2021-12-03 20:34:05 -0800 |
commit | c0bd17799c1ae1f83dc4bb3ebf5407eac263cfc3 (patch) | |
tree | 6adce7becb097855a12c20a99e09d061e56073fe | |
parent | 2608753d9cc08d133c2ba50e5f53104220dd3229 (diff) |
Document installation and usage.
-rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
@@ -1,2 +1,23 @@ | |||
1 | # webgen | 1 | # webgen |
2 | |||
2 | The static site generator for my site. | 3 | The static site generator for my site. |
4 | |||
5 | ## Requirements | ||
6 | |||
7 | [Janet](https://janet-lang.org/) is required to build and run the generator. | ||
8 | |||
9 | [pandoc](https://pandoc.org/) is required for processing markdown files. | ||
10 | |||
11 | ## Build | ||
12 | |||
13 | ``` | ||
14 | jpm build | ||
15 | ``` | ||
16 | |||
17 | ## Usage | ||
18 | |||
19 | ``` | ||
20 | webgen src/ | ||
21 | ``` | ||
22 | |||
23 | where `src/` is the directory to the site's source files. | ||