summaryrefslogtreecommitdiff
path: root/bump/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'bump/README.md')
-rw-r--r--bump/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/bump/README.md b/bump/README.md
new file mode 100644
index 0000000..17521c7
--- /dev/null
+++ b/bump/README.md
@@ -0,0 +1,14 @@
+# bump.lua simple demo
+
+This is the simple demo of [bump.lua](http://github.com/kikito/bump.lua)
+
+It requires [LÖVE](http://love2d.org) to work properly.
+
+This simple demo creates a world populated by random boxes, and allows to move a player around using the keyboard arrow keys. The player has constant velocity
+and can will "slide" over the boxes without penetrating them, similarly to some classic games such as Zelda.
+
+Pressing TAB will display some debug information.
+
+![simpledemo](https://kikito.github.io/bump.lua/img/bump-simpledemo.gif)
+
+