From 58577d7e4362b0212922b34f5a9d5250d83930ac Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Mon, 2 Nov 2015 17:25:33 -0700 Subject: [PATCH] * Start putting together some docs. Nothing really to see yet --- docs/about.md | 16 ++++++++++++++++ docs/index.md | 1 + mkdocs.yml | 10 ++++++++++ 3 files changed, 27 insertions(+) create mode 100644 docs/about.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 00000000..55d0a45f --- /dev/null +++ b/docs/about.md @@ -0,0 +1,16 @@ +# About ENiGMA½ + +## High Level Feature Overview +* Multi platform: Anywhere Node.js runs likely works (tested under Linux and OS X) +* Multi node support +* **Highly** customizable via [HJSON](http://hjson.org/) based configuration, menus, and themes in addition to JS based mods +* MCI support for lightbars, toggles, input areas, and so on plus many other other bells and whistles +* Telnet & SSH access built in. Additional servers are easy to implement & plug in +* [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. +* [SAUCE](http://www.acid.org/info/sauce/sauce.htm) support +* Renegade style pipe codes +* [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 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..4147360f --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +## Index \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..52b142e4 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,10 @@ +site_name: ENiGMA½ BBS Software +site_author: Bryan Ashby +repo_url: https://github.com/NuSkooler/enigma-bbs +theme: readthedocs + +pages: + - Introduction: 'index.md' + - Raspberry Pi: 'rpi.md' + - About: 'about.md' +