diff options
| author | Jan Tuomi <jans.tuomi@gmail.com> | 2024-02-08 09:29:34 +0200 |
|---|---|---|
| committer | Jan Tuomi <jans.tuomi@gmail.com> | 2024-02-08 09:29:34 +0200 |
| commit | e6eccb1141ce949d32a6908a8297b6c57c2ff12d (patch) | |
| tree | 384ae50d851c04f81c32692938b8dd9b4b1ed642 | |
| parent | 2c729d5540529c3536ee8ee9a5f729c3c7dfb7f2 (diff) | |
Add README
| -rw-r--r-- | README.md | 20 | ||||
| -rw-r--r-- | requirements.list | 2 | ||||
| -rw-r--r-- | todo.txt | 2 |
3 files changed, 22 insertions, 2 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) | diff --git a/requirements.list b/requirements.list index b386598..2bece13 100644 --- a/requirements.list +++ b/requirements.list @@ -9,4 +9,4 @@ (utf8 "3.6.3") (nrepl "5.0.8") (matchable "1.1") -(shell "0.4"))) + @@ -1,4 +1,4 @@ x 2024-02-07 2024-02-07 feat: Make pages and dist folders configurable via env 2024-02-07 feat: Add sxml transform step that parses ![[url]] image links 2024-02-07 feat: self-host font instead of Google dependency -2024-02-07 doc: Add README +x 2024-02-08 2024-02-07 doc: Add README |