From dbf17288d2eafd5863c9ef35c633942457880d8b Mon Sep 17 00:00:00 2001 From: Andrew Pamment Date: Wed, 23 Mar 2016 18:34:34 +1000 Subject: [PATCH] Modified README with install instructions --- README.md | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 843423f..831ed91 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,47 @@ lose it again! Magicka is meant to be a modern (haha) BBS system, using modern technologies, like Sqlite, XMPP, long filenames (gasp!) etc while still retaining the classic BBS feel. ANSI & Telnet, and good old ZModem. -Currently it's in it's very early (re)development. You can sign up, login and log off. ie. Don't use it yet. + I plan to work on things in this order: -* Mail System (using JAM LIB for compatability) -* External Door Support +* Mail System (using JAM LIB for compatability) (Mostly Done) +* External Door Support (Mostly Done) * File Systems * Everything else.. +#### Magicka BBS is not yet complete!! + +If you want to install Magicka BBS, follow these steps. + +1. Ensure you have git, c compiler, sqlite-dev and gnu make +2. Clone the repo "git clone https://github.com/apamment/MagickaBBS +3. Build JamLib + + cd MagickaBBS + ./configure + make + su + make install + +4. Build the BBS (You may have to adjust the Makefile for your system) + + gmake + +5. Copy the config-default directory to a config directory. + + cp -r config-default config + +6. Edit the config files and update essential information, like system paths and BBS name etc +7. Copy the ansi-default directory to the one specified in your system path + + eg. + + cp -r ansi-default ansi + +8. Run Magicka BBS on a port over 1024 (Below require root, and wer're not ready for that). + + ./magicka config/bbs.ini 2300 + +9. Your BBS is now running on port 2300, log in and create yourself an account! (By default there is only one +security level, you can add more, but you will need to use an SQLite Manager to modify users.sq3 and set security levels, as there is no user editor yet.