summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..3ab53a7
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+BUILDING
+--------
+To build just run 'make'. To run, just type 'xd'.
+
+
+DESCRIPTION
+-----------
+
+xd is a basic framework to make it easy to write the odd "I'm bored for 10
+minutes" graphical hacks.
+
+GENERAL KEYS
+------------
+
+Press 'Page up' and 'Page down' to cycle through the demos. The window title
+will contain the name of the current demo, sometimes along with additional
+instructions.