From 58bde9784dd6721b6782efc83590c6b4e900bced Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Fri, 20 Nov 2015 09:43:10 -0700 Subject: [PATCH] * Minor update to config.md --- docs/config.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/config.md b/docs/config.md index 3039b05f..bd89eb99 100644 --- a/docs/config.md +++ b/docs/config.md @@ -2,7 +2,7 @@ Configuration files in ENiGMA½ are simple UTF-8 encoded [HJSON](http://hjson.org/) files. HJSON is just like JSON but simplified and much more resilient to human error. ### System Configuraiton -The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. This file shoudl be created in `~/.config/enigma-bbs/config.hjson`. Values found in core/config.js may be overridden by simply providing the object members you wish replace. +The main system configuration file, `config.hjson` both overrides defaults and provides additional configuration such as message areas. The default path is `~/.config/enigma-bbs/config.hjson` though you can override this with the `--config` parameter when invoking `main.js`. Values found in core/config.js may be overridden by simply providing the object members you wish replace. #### Example: System Name `core/config.js` provides the default system name as follows: @@ -19,4 +19,7 @@ general: { } ``` -TODO: document Windows ~/... path example \ No newline at end of file +TODO: document Windows ~/... path example + +### Menus +TODO: Documentation on menu.hjson, etc. \ No newline at end of file