aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51ea1a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+Snake
+=====
+
+Dependency
+----------
+
+1. sdl2 with OpenGL support
+2. sdl2\_ttf
+3. sdl2\_mixer with FLAC support (optional)
+
+Build
+-----
+
+Download contrib resources and extract
+to contrib/
+
+`cd src`
+
+`make`
+
+With GPIO support:
+
+`make -DGPIO`
+
+With SOUND support:
+
+`make -DSOUND`
+
+Run
+---
+
+`./snake`
+
+Installation
+------------
+
+`make install`
+
+To-do
+-----
+
+* Leaderboard (SQLite)