diff --git a/README.md b/README.md index 81996ef..0e8128c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,36 @@ # Sanke A simple snake game in the terminal. No third party libraries needed. -## Demo -Click image for video +# Compiling +Run: +```sh +compile.sh release +``` +to compile an optimized build. The script creates a directory called 'target' that contains the executable. -[![Sanke demo](https://img.youtube.com/vi/_coOVAW9qa4/0.jpg)](https://www.youtube.com/watch?v=_coOVAW9qa4) +See: +```sh +compile.sh help +``` +for more. -## How it works +# Running +Run: +```sh +sanke +``` +to play with defaults settings. + +See: +```sh +sanke --help +``` +for setting game options. + +# How it works The program makes the terminal use non-canonical input and output by using termios. Then it updates and prints a 2D character array containing the board borders, snake, and food. Before terminating, the program restores canonical mode. -## Info +# Info Only tested with the combination of - GCC - Linux diff --git a/compile.sh b/compile.sh index 4907509..3cc3f42 100755 --- a/compile.sh +++ b/compile.sh @@ -6,6 +6,18 @@ if [ -v 1 ]; then arg=$1 fi +if [ $arg = "help" ]; then + echo "USAGE: compile.sh