aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2020-08-03 12:56:45 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2020-08-03 12:56:45 +0200
commitba40ae8fd964b5466f70d997796e0e24343019c6 (patch)
tree038d1228d84eb91ac775a48c4350445b4978da90 /README
parentUpdate README with new build instructions. (diff)
downloadcalp-ba40ae8fd964b5466f70d997796e0e24343019c6.tar.gz
calp-ba40ae8fd964b5466f70d997796e0e24343019c6.tar.xz
Add documentation about the configuration system.configure
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index ec74ed90..3bf535db 100644
--- a/README
+++ b/README
@@ -56,6 +56,14 @@ Techical Details
----------------
- Internally all weeks start on sunday, which is repsenented as `0'.
+== The configuration system ==
+For all user provided variables a purpose built configuration system
+is used. Thee module `(util config)` exposes the bindings
+`define-config` along with `set-config` and `get-config`. The idea
+behind this, instead of direct variables, is to make it clearer what
+is part of the configurable environment, it allows a set! before the
+point of definition, and it makes values constraints easier to
+manage.
References
----------