diff --git a/README.md b/README.md index a3013a0c..ca3b7412 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ENiGMA½ is a modern BBS software with a nostalgic flair! * [CP437](http://www.ascii-codes.com/) and UTF-8 output * [SyncTERM](http://syncterm.bbsdev.net/) style font and baud emulation support. Display PC/DOS and Amiga style artwork as it's intended! In general, ANSI-BBS / [cterm.txt](http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/src/conio/cterm.txt?content-type=text%2Fplain&revision=HEAD) / [bansi.txt](http://www.bbsdocumentary.com/library/PROGRAMS/GRAPHICS/ANSI/bansi.txt) are followed for expected BBS behavior. * Full [SAUCE](http://www.acid.org/info/sauce/sauce.htm) support. - * Renegade style [pipe color codes](/docs/configuration/colour-codes.md). + * Renegade style [pipe color codes](./docs/configuration/colour-codes.md). * [SQLite](http://sqlite.org/) storage of users, message areas, etc. * Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password encryption. * Support for 2-Factor Authentication with One-Time-Passwords @@ -28,7 +28,7 @@ ENiGMA½ is a modern BBS software with a nostalgic flair! ...and much much more. Please check out [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) and feel free to request features (or contribute!) features! ## Documentation -[Browse the docs online](https://nuskooler.github.io/enigma-bbs/). Be sure to checkout the [/docs/](/docs/) folder as well for the latest and greatest documentation. +[Browse the docs online](https://nuskooler.github.io/enigma-bbs/). Be sure to checkout the [/docs/](./docs/) folder as well for the latest and greatest documentation. ## Installation On most *nix systems simply run the following from your terminal: diff --git a/UPGRADE.md b/UPGRADE.md index 7e352c31..117b4bff 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -2,7 +2,7 @@ This document covers basic upgrade notes for major ENiGMA½ version updates. # Before Upgrading -* Always back up your system! (See [Administration](/docs/admin/administration.md)) +* Always back up your system! (See [Administration](./docs/admin/administration.md)) * Seriously, always back up your system! # General Notes @@ -12,7 +12,7 @@ In general, look at template menu files in `misc/menu_templates`, and `config_te ### Menus & Theme Updates Upgrades often come with changes to the default menu templates found in `misc/menu_tempaltes`. You can use these as references for changes and additions to the default menu sets. This also applies to the default `luciano_blocktronics` theme and it's `theme.hjson` file. -See [Updating](/docs/admin/updating.md) for details on menu files/etc. +See [Updating](./docs/admin/updating.md) for details on menu files/etc. # Upgrading the Code Upgrading from GitHub is easy: diff --git a/WHATSNEW.md b/WHATSNEW.md index acef4338..c5071ef7 100644 --- a/WHATSNEW.md +++ b/WHATSNEW.md @@ -2,17 +2,17 @@ This document attempts to track **major** changes and additions in ENiGMA½. For details, see GitHub. ## 0.0.12-beta -* The `master` branch has become mainline. What this means to users is `git pull` will always give you the latest and greatest. Make sure to read [Updating](/docs/admin/updating.md) and keep an eye on `WHATSNEW.md` (this file) and [UPGRADE](UPGRADE.md)! See also [ticket #276](https://github.com/NuSkooler/enigma-bbs/issues/276). +* The `master` branch has become mainline. What this means to users is `git pull` will always give you the latest and greatest. Make sure to read [Updating](./docs/admin/updating.md) and keep an eye on `WHATSNEW.md` (this file) and [UPGRADE](UPGRADE.md)! See also [ticket #276](https://github.com/NuSkooler/enigma-bbs/issues/276). * The default configuration has been moved to [config_default.js](/core/config_default.js). * A full configuration revamp has taken place. Configuration files such as `config.hjson`, `menu.hjson`, and `theme.hjson` can now utilize includes via the `includes` directive, reference 'self' sections using `@reference:` and import environment variables with `@environment`. * An explicit prompt file previously specified by `general.promptFile` in `config.hjson` is no longer necessary. Instead, this now simply part of the `prompts` section in `menu.hjson`. The default setup still creates a separate prompt HJSON file, but it is `includes`ed in `menu.hjson`. With the removal of prompts the `PromptsChanged` event will no longer be fired. -* New `PV` ACS check for arbitrary user properties. See [ACS](/docs/configuration/acs.md) for details. +* New `PV` ACS check for arbitrary user properties. See [ACS](./docs/configuration/acs.md) for details. * The `message` arg used by `msg_list` has been deprecated. Please starting using `messageIndex` for this purpose. Support for `message` will be removed in the future. ## 0.0.11-beta * Upgraded from `alpha` to `beta` -- The software is far along and mature enough at this point! * Development is now against Node.js 12.x LTS. Other versions may work but are not currently supported! -* [QWK support](/docs/messageareas/qwk.md) +* [QWK support](./docs/messageareas/qwk.md) * `oputil fb scan *areaTagWildcard*` scans all areas in which wildcard is matched. * The archiver configuration `escapeTelnet` has been renamed `escapeIACs`. Support for the old value will be removed in the future.