diff --git a/README.md b/README.md index 5f92c0d..400f98a 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# console-tetris \ No newline at end of file +# console-tetris + +> A terminal ui to play tetris in the console + +![image](https://user-images.githubusercontent.com/49595640/177736119-8bf99c5c-db85-4b22-9287-5674cfb78e69.png) + +## Features + +* Support for big and small terminals +* Progress is saved at ```~/.config/console-tetris/console-tetris.conf``` +* Growing difficulty with increasing levels +* Point calculation like on [Nintendo's Tetris versions](https://tetris.fandom.com/wiki/Scoring) +* Tetromino rotation like on [the Gamebody version](https://strategywiki.org/wiki/File:Tetris_rotation_Gameboy.png) + +### Shortcuts + +* Exit the program +* Pause the game +* Reset the game + +## Usage + +This program has a single dependency to [ncurses](https://archlinux.org/packages/core/x86_64/ncurses/) and was coded and tested on Arch