diff --git a/README.md b/README.md index 74820c0..101c242 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,17 @@ # Snake Game in C++ -A simple snake game, with terminal GUI implemented using ncurses library +## Abstract +A simple snake game, with terminal GUI implemented using ncurses library. +#### Controls: +- __Up-Arrow__ to go up. +- __Down-Arrow__ to go down. +- __Left-Arrow__ to go left. +- __Right-Arrow__ to go right. +- __q__ to exit game. + +--- + ## Prerequisities You need to install the following two packages: @@ -17,11 +27,35 @@ Open up a terminal and type the folllowing commands #And the actuall library ~$ sudo apt-get install libncurses5-dev libncursesw5-dev ``` +Now you are ready to use the repo. + +--- ## Downloading, Instalation and Running the Program Now we will install and run teh program, but first let's download the repo: ``` -~$ git clone https://github.com/VissaMoutafis/Snake-Game-in-C- -~$ cd Ch +~$ git clone https://github.com/VissaMoutafis/Snake_Game_in_Cpp +~$ cd Snake_Game_in_Cpp +~$ make run +``` + +and enjoy playing! + +__Note__: You might want to delete the objective files and keep only the src part. In that case: +``` +~$ make clean ``` +and you are set. + +--- + +## Contributors +[VissaM](https://github.com/VissaMoutafis) + +--- + +## Licence: MIT +Check the file LICENCE. + +### Enjoy!