aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jans.tuomi@gmail.com>2024-01-20 14:46:09 +0200
committerJan Tuomi <jans.tuomi@gmail.com>2024-01-20 14:46:09 +0200
commit7f17974ba5ec82981b609c2b129d4459a42ba269 (patch)
tree7c1eef0df65d9a854eff4ef22fd433285a9ee1cd /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..207a693
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# desmoctl
+
+A tool for controlling a desmofylakas cluster written in Chicken Scheme.
+
+## Installation
+
+Install [Chicken Scheme](https://wiki.call-cc.org/platforms).
+
+Run the tool in the interpreter with tests:
+
+ INLINE_TESTS=1 csi -s desmoctl.scm
+
+Compile the tool for production.
+
+ csc -O3 -o desmoctl desmoctl.scm
+
+## Usage
+
+See `desmoctl help`.