moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* Minor update to config.md

This commit is contained in:
Bryan Ashby 2015-11-20 09:43:10 -07:00
parent 09f6ad1d0c
commit 58bde9784d
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/config.md
View File

@ -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:
@ -20,3 +20,6 @@ general: {
```
TODO: document Windows ~/... path example
### Menus
TODO: Documentation on menu.hjson, etc.