diff --git a/UPGRADE.md b/UPGRADE.md index 94bd4950..76f9e532 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -1,9 +1,9 @@ # Introduction -This document covers basic upgrade notes for major ENiGMA½. +This document covers basic upgrade notes for major ENiGMA½ version updates. # Before Upgrading -* Alwasy back up your system! +* Always back up your system! * At least back up the `db` directory and your `menu.hjson` (or renamed equivalent) @@ -22,7 +22,7 @@ After updating code, use a program such as DiffMerge to merge in updates to `my_bbs.hjson` from the shipping `menu.hjson`. -# Pulling Latest From GitHub +# Upgrading the Code Upgrading from GitHub is easy: ```bash @@ -39,7 +39,7 @@ Report your issue on Xibalba BBS, hop in #enigma-bbs on Freenet and chat, or # 0.0.1-alpha to 0.0.4-alpha ## Node.js 6.x+ LTS is now **required** -You will need to upgrade Node.js to [6.x+](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V6.md). If using nvm (you should be!) the process will go something like this: +You will need to upgrade Node.js to [6.x+](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V6.md). If using [nvm](https://github.com/creationix/nvm) (you should be!) the process will go something like this: ```bash nvm install 6 nvm alias default 6 @@ -56,3 +56,6 @@ sqlite> INSERT INTO message_fts(message_fts) VALUES('rebuild'); ## Archiver Changes If you have overridden or made additions to archivers in your `config.hjson` you will need to update them. See [Archive Configuration](docs/archive.md) and `core/config.js` + +## File Base Configuration +As 0.0.4-alpha contains file bases, you'll want to create a suitable configuration if you wish to use the feature. See [File Base Configuration](docs/file_base.md).