summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
index e69de29..e95a87f 100644
--- a/README
+++ b/README
@@ -0,0 +1,20 @@
+Boukengine
+----------
+
+Boukengine is an engine for developing adventure role-playing games with
+a 2-D top-down third-person perspective and turn-based combat.
+Boukengine renders tile-based and layered world maps and manages color
+palettes with realistic day/night cycling.
+
+Building
+--------
+
+Boukengine requires the following library packages to build and run:
+
+ * `SDL` 1.2
+ * `SDL_image` 1.2
+ * `Expat`
+ * `zlib`
+ * `Lua` 5.1 or later
+
+Boukengine additionally requires `xcftools` at build time.