aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a4eda4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Bayonet CMS
+
+- Version 0.0.1 Alpha
+
+
+
+## Description
+
+Bayonet is a CMS designed for online gaming units. It comes with the member management module RUDI.
+
+
+## Usage
+
+This project is not actively managed. Use this software at your own risk.
+
+
+## Installation
+
+Initialize your database with this [schema](schema.sql).
+
+#### Admin account
+ Username: admin
+ Password: password
+
+Configure and rename [config.example.php](include/config.example.php) to `config.php`
+
+
+## Contributors
+
+- [Joe Hunkeler](https://github.com/jhunkeler)
+- [Evan O'Connell](https://github.com/eoconnell)
+- [Alan Brault](https://github.com/extrarius)
+- Jesse Larrabee