Write README file

Signed-off-by: Malf Furious <m@lfurio.us>

1 files changed, 53 insertions, 0 deletions

diff --git a/README.md b/README.md
index e69de29..85441e6 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,53 @@
+SCROTT - The Secure Centralized Robust Online Ticketing Tool
+============================================================
+
+This is the alpha version of Scrott, which is currently only a very simplistic
+and generic issue tracker, supporting multiple users and project boards (called
+'pads').  The alpha will constitute the v0.1.x series of releases.  Expect some
+upcoming quality-of-life changes to the alpha, as well as bug fixes.
+
+The v0.2 series of releases and on are reserved for the beta, which I am
+planning a full rewrite for soon.  This progress can be tracked on the 'dev'
+source branch.
+
+
+INSTALLATION
+------------
+
+Scrott requires PHP 7.2, with the mysqli and gd extensions.  Scrott also
+requires a MySQL or MariaDB database.  The recommended server platform is Nginx.
+
+Use the supplied file 'srvs/nginx.conf' as a baseline for your server
+configuration.  The web-root should be the 'app/' directory; however, Scrott
+can handle being placed in some sub-directory tree of your web as well.
+Internal hyperlinks will adjust.
+
+Execute the supplied file 'srvs/mysql.sql' in the MySQL client to initialize an
+empty database for Scrott.
+
+Make sure to make the 'app/dynmic/' directory writable by your web server.
+Uploaded files are placed here.  You should *ABSOLUTELY* deny access to this
+directory through your web server, the file 'app/df.php' is used to safely
+serve these files instead.
+
+Arrange for the file 'app/cron.php' to be run periodically.  It performs
+tasks such as cleaning up old database objects.
+
+Navegate to your installation in a web browser.  You should be presented with a
+page stating "Welcome to Scrott"!  Enter your database parameters here.  The next
+page allows you to register the first administrator user.
+
+Once a single administrator user exists, installation is complete.  Navegating
+to the site signed-out should show only the login page.  Additional account
+registration can be enabled via the admin general settings tab.
+
+
+CONTRIBUTING
+------------
+
+I am currently accepting patches for the alpha series only.  Send your patches
+via email to the maintainer.  Alternatively, a pull request (formatted with
+the 'git request-pull' command) may be sent.
+
+In either case, if your patches form a series, a separate message should be
+present summarizing the changes and _why_ they are needed.