From e6eccb1141ce949d32a6908a8297b6c57c2ff12d Mon Sep 17 00:00:00 2001
From: Jan Tuomi <jans.tuomi@gmail.com>
Date: Thu, 8 Feb 2024 09:29:34 +0200
Subject: Add README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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) |
-- 
cgit v1.3