From 56131511cb7a3db103b3d80db471a9f34f4d8fb2 Mon Sep 17 00:00:00 2001 From: Mathew Guest Date: Wed, 11 Mar 2020 23:18:51 -0600 Subject: [PATCH] referenced ConfigObj documentation links --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5d5b31..3260bd3 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,18 @@ Principles: Application Configuration ------------------------- -Site configurations are supported through configobj. There is a config.spec +Site configurations are supported through ConfigObj. There is a config.spec in the src directory which is a validation file; it contains the accepted parameter names, types, and limits for configurable options in the application which is built on app_skellington. The format is multi-level .ini syntax. -See the configobj documentation for more information. +Reference the ConfigObj documentation for config.ini and config.spec +format. See: -Site configuration files (config.ini) are created if they don't exit. The + * https://configobj.readthedocs.io/en/latest/configobj.html#the-config-file-format + * https://configobj.readthedocs.io/en/latest/configobj.html#validation + +Config files (config.ini) are created if they don't exist. The file always contains the full specification of parameters; i.e. even default parameters are added into the config file. @@ -42,7 +46,7 @@ Application configuration can be overridden ad-hoc through the --config