diff --git a/README.md b/README.md index 42572c2..9ed2796 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,67 @@ -# serpent -work in progress... +# Serpent + +## Introduction + +Yet another snake game remake written in C for the console. + +## Table of Contents + +- [Installation](#installation) +- [Controls](#controls) +- [Gameplay](#gameplay) +- [Command Line Options](#command-line-options) +- [Contributing](#contributing) +- [License](#license) + +## Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/d4r1us-drk/serpent.git + ``` + +2. Compile the program using make: + + ```bash + make + ``` + +3. Run the game: + + ```bash + ./serpent + ``` + +## Controls + +- Arrow Up: Move Up +- Arrow Down: Move Down +- Arrow Left: Move Left +- Arrow Right: Move Right +- `p`: Pause the game + +## Gameplay + +1. Start the game by selecting "Start Game" from the main menu. +2. Control the snake's direction using the arrow keys. +3. Collect apples to grow the snake and increase your score. +4. Avoid collisions with the walls and the snake's own body. +5. Press `p` to pause the game. +6. Game ends if the snake collides with the walls or itself. + +## Command Line Options + +- `-c, --show-controls`: Display the game controls. +- `-h, --help`: Display help message and exit. +- `-v, --version`: Display version information and exit. + +## Contributing + +Feel free to contribute by suggesting ideas, reporting issues, or submitting +pull requests. + +## License + +This program is distributed under the [GNU General Public License +v3.0](http://www.gnu.org/licenses/).