diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2020-08-03 12:56:45 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2020-08-03 12:56:45 +0200 |
commit | ba40ae8fd964b5466f70d997796e0e24343019c6 (patch) | |
tree | 038d1228d84eb91ac775a48c4350445b4978da90 | |
parent | Update README with new build instructions. (diff) | |
download | calp-ba40ae8fd964b5466f70d997796e0e24343019c6.tar.gz calp-ba40ae8fd964b5466f70d997796e0e24343019c6.tar.xz |
Add documentation about the configuration system.configure
-rw-r--r-- | README | 8 | ||||
-rw-r--r-- | README.in | 2 |
2 files changed, 10 insertions, 0 deletions
@@ -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 ---------- @@ -40,6 +40,8 @@ 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 ---------- |