From f8c9c435ab9866e3311deea5d7f3522d82e6d015 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Fri, 20 Nov 2015 11:56:57 -0700 Subject: [PATCH] * Some doc changes --- README.md | 44 +------------------------------------------- mkdocs.yml | 1 + 2 files changed, 2 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index a91d731d..3d6687eb 100644 --- a/README.md +++ b/README.md @@ -47,49 +47,7 @@ ENiGMA has been tested with many terminals. However, the following are suggested ## Installation -**Clone** -```bash -git clone https://github.com/NuSkooler/enigma-bbs.git - -``` -**Create a Config** -```hjson -/* ~/.config/enigma-bbs/config.hjson */ -general: { - boardName: Super Awesome BBS -} -messages: { - areas: [ - { name: "local_enigma_discusssion", desc: "ENiGMA Discussion", groups: [ "users" ] } - ] -} -``` - -**Install dependencies** -```bash -npm install -``` - -**Generate a PK for SSH usage** -```bash -mkdir misc -openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048 -``` - -After generation, set servers.ssh.privateKeyPass to your password in config.hjson: -```hjson -servers: { - ssh: { - privateKeyPass: YOUR_PK_PASS - } -} -``` - -**Launch** -```bash -node main.js -``` -(More information will be available in the documentation in the near future) +Please see the [Quickstart](docs/config.md#quickstart) ## Special Thanks * [M. Brutman](http://www.brutman.com/), author of [mTCP](http://www.brutman.com/mTCP/mTCP.html) (Interwebs for DOS!) diff --git a/mkdocs.yml b/mkdocs.yml index 52b142e4..bf2d198f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,7 @@ theme: readthedocs pages: - Introduction: 'index.md' + - Configuration: 'config.md' - Raspberry Pi: 'rpi.md' - About: 'about.md'