From 2a630eaa5aaf6bb8dac0a68e1210e99e204e6409 Mon Sep 17 00:00:00 2001
From: Yamagi Burmeister <yamagi@yamagi.org>
Date: Sun, 5 Nov 2017 15:19:04 +0100
Subject: [PATCH] Add a small README.

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c617eac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# 3rd Zigock Bot II for Yamagi Quake II
+
+This is a best effort port of the  3rd Zigock Bot II to Yamagi Quake II. 
+The code is nearly unchanged from the original, just some scary compiler
+warning were fixes and some hard coded pathes were changed to make use
+of Yamagi Quake IIs enhanced, unix compatible VFS.
+
+## Installation
+
+* Extract the ZIP archive *misc/assets.zip* to your Quake II directory.
+* Build the game.so by calling `make` and copy it to the 3zb2/ dir.
+
+For more informations refer to the user guide, included with the assets.
+