1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a74bf8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# snake in c and ncurses
+
+Simple snake game written in C using ncurses. The code is well commented and should step you through the flow nicely. A thread is used for user input. Controls displayed on screen.
+
+# things to change
+Change the board width and height by editing:
+```
+#define WIDTH 20
+#define HEIGHT 20
+```
+
+Change the speed of the game by altering the int at the bottom of update() passed to usleep(). A recommended value is there commented out.
+
+# compiling and running
+compile and run using:
+```
+gcc snake.c -o snake -lncurses -lpthread && ./snake
+```