* Updated config.md to note Windows ~ path
This commit is contained in:
parent
97ac37deb9
commit
82a234fffd
|
@ -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.
|
Loading…
Reference in New Issue