From 96b0f24132ca8eac4c2230f13d78eac326081c61 Mon Sep 17 00:00:00 2001 From: Giovani Rodriguez Date: Sat, 10 Jul 2021 14:20:00 -0400 Subject: [PATCH] chore: update readme --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0a9e403..8623285 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,18 @@ [![Total alerts](https://img.shields.io/lgtm/alerts/g/gio101046/tetri5.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/gio101046/tetri5/alerts/) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/gio101046/tetri5.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/gio101046/tetri5/context:python) -The tetri5 project was created for the purpose of becoming familiar with Python 3. The goal is to replicate the most current version of Tetris (https://tetris.com/play-tetris) down to every mechanic. This includes the way pieces rotate and even newer features such as the ghost piece. +The tetri5 project was created for the purpose of becoming familiar with Python 3. The game was created using the pygame python library and builds on Github are packaged into one executable using cx_Freeze. -The game was created using the pygame python library and builds on Github are packaged into one executable using cx_Freeze. +The goal is to implement the features of the current version of Tetris (https://tetris.com/play-tetris) and add some extra ones with a unique twist. + +### Feature List +- [x] Rotate Right +- [ ] Rotate Left +- [x] Soft Drop +- [x] Hard Drop +- [x] Lock Delay +- [ ] Wall Kick +- [x] Next Piece ## Demo @@ -14,11 +23,10 @@ The game was created using the pygame python library and builds on Github are pa Make sure you have installed Python 3. If you have not, download and install Python 3 at [python.org](https://www.python.org/downloads/). -Then use the package manager [pip](https://pip.pypa.io/en/stable/) to install the required packages. +Then use the package manager [pip](https://pip.pypa.io/en/stable/) to install the required dependencies. ```bash -pip install pygame -pip install pyyaml +pip install -r requirements.txt ``` ## Run the Game @@ -37,3 +45,6 @@ python3 main.py ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License +[MIT](https://choosealicense.com/licenses/mit/)