chore: add project readme

This commit is contained in:
2021-06-09 14:45:07 -04:00
parent 25571a763f
commit 741190ca2e

33
README.md Normal file
View File

@@ -0,0 +1,33 @@
# Python Tetris Clone
The python-tetris-clone 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 game was created using the pygame python library and builds on Github are packaged into one executable using cx_Freeze.
## Requirements
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.
```bash
pip install pygame
pip install pyyaml
```
## Run the Game
Clone the Github repository. From your terminal move to the root of the project and run the following line:
```bash
python main.py
```
In some systems you may need to run this instead:
```bash
python3 main.py
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.