Add README

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..8b8941c
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+This repo contains two projects: Demonchime and Teensy.
+
+Teensy is a game engine/game framework built with Demonchime in mind. Its
+primary features are a software renderer and a platform abstraction. With these
+two features, the game should be able to be ported to basically any platform I
+want it to run on, just so long as it meets the minimum specs.
+
+Demonchime is a game that I'm still working out the details of. It is currently
+not in development as Teensy is not at a stage where it can be used to make
+Demonchime. The working idea of Demonchime is that it's a combat-focused
+metroidvania.
+
+== Compiling ==
+
+Currently only compiles on Linux. You may be able to get it to compile on
+Windows with some effort.
+
+To build:
+
+$ ./build.sh
+
+It will output an executable called `demonchime'.
+
+== Project structure ==
+
+(May not be completely up-to-date)
+
+- /dc - demonchime
+- /teensy - teensy source code
+- /platform - platform implementations. There is currently X11 and GL, but GL
+  is more actively maintained.