summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorIan C <ianc@noddybox.co.uk>2017-01-09 13:52:27 +0000
committerIan C <ianc@noddybox.co.uk>2017-01-09 13:52:27 +0000
commit3196c12dd83bcf88b3448264dc4afff87054541e (patch)
tree1a68c2aef5532369eaf841fffc6eeedb6c8bc838 /README
parent0ea8e23456b44365d30ad8a80357c3a2711fee11 (diff)
Added README, additional instructions and removed (pointless) dependency file
from make.
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.