From 82a234fffda7ddafeb36edaa2cf511181d6a9193 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 21 Nov 2015 13:34:30 -0700 Subject: [PATCH] * Updated config.md to note Windows ~ path --- docs/config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config.md b/docs/config.md index bd89eb99..78601cc7 100644 --- a/docs/config.md +++ b/docs/config.md @@ -4,6 +4,8 @@ Configuration files in ENiGMA½ are simple UTF-8 encoded [HJSON](http://hjson.or ### System Configuraiton 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. +**Windows note**: **~** resolves to *C:\Users\YOURLOGINNAME\* on modern installations, e.g. *C:\Users\NuSkooler\\.config\enigma-bbs\config.hjson* + #### Example: System Name `core/config.js` provides the default system name as follows: ```javascript @@ -19,7 +21,5 @@ general: { } ``` -TODO: document Windows ~/... path example - ### Menus TODO: Documentation on menu.hjson, etc. \ No newline at end of file