From c0bd17799c1ae1f83dc4bb3ebf5407eac263cfc3 Mon Sep 17 00:00:00 2001 From: msunet Date: Fri, 3 Dec 2021 20:34:05 -0800 Subject: Document installation and usage. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 810ceb9..db84661 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # webgen + The static site generator for my site. + +## Requirements + +[Janet](https://janet-lang.org/) is required to build and run the generator. + +[pandoc](https://pandoc.org/) is required for processing markdown files. + +## Build + +``` +jpm build +``` + +## Usage + +``` +webgen src/ +``` + +where `src/` is the directory to the site's source files. -- cgit v1.2.3