From 377d3910339005191f82db9bdda0f8fca4512b2a Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Tue, 27 Oct 2015 16:20:44 -0600 Subject: [PATCH] * Updated readme a bit --- README.md | 81 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 50 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 3069424a..b8cb9268 100644 --- a/README.md +++ b/README.md @@ -16,57 +16,76 @@ ENiGMA½ is a modern BBS software with a nostalgic flair! * [SQLite](http://sqlite.org/) storage of users and message areas * Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password storage * Door support including common dropfile formats and [DOSEMU](http://www.dosemu.org/) + * [Bunyan](https://github.com/trentm/node-bunyan) logging ## In the Works -* Lots of code cleanup, and **documentation** +* Lots of code cleanup, ES6+ usage, and **documentation**! * FTN import & export * File areas +* Full access checking framework +* SysOp console * Missing functionality such as searching, pipe code support in message areas, etc. * A lot more! -## Alpha +## Known Issues As of now this is considered alpha code! Please **expect bugs** -- and when you find them, log issues and/or submit pull requests. Feature requests, suggestions, and so on are always welcome! I am also looking for semi dedicated testers, artists, etc. ## Boards -TODO WHQ & support boards +* WQH: Xibalba +* Official support: [BLACK ƒlag](http://www.bbsnexus.com/directory/listing/blackflag.html) ## Installation -TODO document futurher - +1. Clone: ```bash git clone https://TODO +``` +2. Create **~/.enigma-bbs/config.hjson**. Example: +```hjson +general: { + boardName: Super Awesome BBS +} +messages: { + areas: [ + { name: "local_enigma_discusssion", desc: "ENiGMA Discussion", groups: [ "users" ] } + ] +} +``` +3. Launch: +``` node main.js ``` +(More information will be available in the documentation in the near future) ## Special Thanks -* M. Brutman, author of [mTCP](http://www.brutman.com/mTCP/mTCP.html) -* M. Griffin, author of [Enthral BBS](https://github.com/M-griffin/Enthral) and Oblivion/2 XRM (https://github.com/M-griffin/Oblivion2-XRM) - +* [M. Brutman](http://www.brutman.com/), author of [mTCP](http://www.brutman.com/mTCP/mTCP.html) (Interwebs for DOS!) +* [M. Griffin](https://github.com/M-griffin), author of [Enthral BBS](https://github.com/M-griffin/Enthral) and [Oblivion/2 XRM](https://github.com/M-griffin/Oblivion2-XRM) +* [Caphood](http://www.reddit.com/user/Caphood), supreme SysOp of [BLACK ƒlag](http://www.bbsnexus.com/directory/listing/blackflag.html) BBS +* Luciano Ayres of [Blocktronics](http://blocktronics.org/) ## License Released under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license: -> Copyright (c) 2015, Bryan D. Ashby -> All rights reserved. -> -> Redistribution and use in source and binary forms, with or without -> modification, are permitted provided that the following conditions are met: -> -> * Redistributions of source code must retain the above copyright notice, this -> list of conditions and the following disclaimer. -> -> * Redistributions in binary form must reproduce the above copyright notice, -> this list of conditions and the following disclaimer in the documentation -> and/or other materials provided with the distribution. -> -> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -> AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -> IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -> DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -> FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -> DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -> SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -> CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -> OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -> OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +Copyright (c) 2015, Bryan D. Ashby +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.