aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jans.tuomi@gmail.com>2024-01-20 19:26:03 +0200
committerJan Tuomi <jans.tuomi@gmail.com>2024-01-20 19:26:03 +0200
commit857071dd1e7a813924e3e17b77dc2782834bd1a2 (patch)
tree9015370908947efdcaa0ed2377b3ca46f38ffe44 /README.md
parent7f17974ba5ec82981b609c2b129d4459a42ba269 (diff)
Add build system
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/README.md b/README.md
index 207a693..ae0203f 100644
--- a/README.md
+++ b/README.md
@@ -6,14 +6,23 @@ A tool for controlling a desmofylakas cluster written in Chicken Scheme.
Install [Chicken Scheme](https://wiki.call-cc.org/platforms).
-Run the tool in the interpreter with tests:
+Run the tool in the interpreter:
- INLINE_TESTS=1 csi -s desmoctl.scm
+ INLINE_TESTS=1 csi -s run.scm # with tests
+ csi -s run.scm # without tests
-Compile the tool for production.
+Compile a statically linked binary for production:
- csc -O3 -o desmoctl desmoctl.scm
+ ./build.sh
## Usage
See `desmoctl help`.
+
+## Development
+
+When adding new modules, add the module names to `modules.list`. The defined module name must match the filename.
+
+## Copyright
+
+© Desmofylakas Core Team 2024 \ No newline at end of file