From ba40ae8fd964b5466f70d997796e0e24343019c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Mon, 3 Aug 2020 12:56:45 +0200 Subject: Add documentation about the configuration system. --- README | 8 ++++++++ README.in | 2 ++ 2 files changed, 10 insertions(+) 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 ---------- diff --git a/README.in b/README.in index 53f906a0..1d293d34 100644 --- a/README.in +++ b/README.in @@ -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 ---------- -- cgit v1.2.3