diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f84d481 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# jan-systems-2024 + +## Prerequisites + +- Install [Chicken Scheme](https://call-cc.org) +- Install [highlight](https://linux.die.net/man/1/highlight) + +## Installation & running + + chicken-install -from-list requirements.list + csi -s app.scm + +## Environment variables + +| Variable | Description | +| -------- | ----------- | +| `PORT` | HTTP server PORT (default: 8080) | +| `SRCROOT` | Relative markdown directory path (default: pages) | +| `WEBROOT` | Relative output directory path (default: dist) | +| `TEMPLATE` | Relative path to HTML file with a single `format` marker (default: template.html) | |