From 936d3d20db7d10aa02e6e09c61c1073a90513aaa Mon Sep 17 00:00:00 2001
From: Aaron van Geffen <aaron@aaronweb.net>
Date: Wed, 30 Dec 2020 13:55:16 +0100
Subject: [PATCH] Add a readme file to the repo.

---
 README    |  1 -
 README.md | 31 +++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 1 deletion(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 50cb4c3..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-This marks the development repository for the HashRU website.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6bdbbff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# HashRU Pics
+
+This is the development repository for the HashRU photo website.
+The CMS and its modules originate in [Kabuki CMS](https://aaronweb.net/projects/kabuki/), but have been extended and are maintained separately in this repository.
+
+## Requirements
+
+The Kabuki codebase requires the following PHP extensions to be enabled for full operation:
+
+* exif
+* imagick (PECL)
+* mysqli
+
+## Setup
+
+Copy `config.php.dist` to `config.php` and set-up the constants contained in the file.
+
+## Running
+
+For development purposes, simply run the `server` script provided in the root of this repository.
+This will start a PHP development server on `hashru.local:8080`.
+
+For a production environment, please set up a proper PHP-FPM environment instead.
+
+## Contributing
+
+Pull requests are welcome over at the [HashRU Gitea](https://gitea.hashru.nl/Public/pics/pulls).
+
+## License
+
+The HashRU Pics repository is licensed with a BSD 3-clause license, as is Kabuki CMS.