* Start putting together some docs. Nothing really to see yet

This commit is contained in:
Bryan Ashby 2015-11-02 17:25:33 -07:00
parent 0f2e88ead3
commit 58577d7e43
3 changed files with 27 additions and 0 deletions

16
docs/about.md Normal file
View File

@ -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

1
docs/index.md Normal file
View File

@ -0,0 +1 @@
## Index

10
mkdocs.yml Normal file
View File

@ -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'