diff --git a/README.md b/README.md index 129b6f5..c4d08da 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,32 @@ -# Terminal Snake +# Snake Game -### Building +A simple terminal-based snake game written in C++. -Use Cmake to build the project with: +## Build + +To build the game, run the following commands: ```bash -mkdir build && cmake -S . -B build && cmake --build build +cmake -S . -B build && cmake --build build ``` -### Running +## How to Run +After building the project, you can run the game with the following command: +```bash +./build/snake +``` -A simple ```./build/snake``` will suffice. +## How to Play +- Use the `w`, `a`, `s`, and `d` keys to control the snake. + - `w`: move up + - `a`: move left + - `s`: move down + - `d`: move right +- The game ends if you collide with yourself. +- Press `q` to quit the game at any time. + +## About + +- This is a simple implementation of the classic Snake game. +- It is written in C++23. +- It uses the `ncurses` library to render the game in the terminal.