This is a minesweeper game to make two amateur coders into pros. On Windows or Mac, you can download minesweeper.exe or minesweeper.dmg from the releases page. On other operating systems, make sure you have Python with Tkinter, and run these commands:

git clone https://github.com/ThePhilgrim/minesweeper
cd minesweeper
python3 minesweeper.py

New changes should usually be made with pull requests. Before merging, your pull request must be reviewed and approved by at least one other person. When merging a pull request, choose "Squash and merge" from the little arrow in the merge button. This way, each pull request shows up as one commit when looking at the commit log of main branch.

When a commit is pushed (or a pull request is merged) to main, .github/workflows/build.yml automatically builds files named minesweeper.exe and minesweeper.dmg, and makes a new release containing them.

Run these commands to start working on a new pull request:

git checkout main
git pull
git checkout -b put_name_of_new_branch_here

Virtual Environments:

• To keep installations project-specific, a virtual environment can be used. This prevents ones computer from being affected by black, pyinstaller, AppDirs, and other things used for the game.
• Installation: cd to the minesweeper folder in your terminal, and run python3 -m venv env (on Windows, you likely need py instead of python3)
• Activation: env\Scripts\activate on Windows, source env/bin/activate on other operating systems
• To delete the virtual env, simply delete the "env" folder inside the minesweeper folder.

This project uses black to clean up code style. Run these commands to use it (with virtualenv activated):

pip install black
black minesweeper.py

The project also uses [AppDirs] (https://github.com/ActiveState/appdirs) that writes the game config file to an appropriate location for regardless of system. To install:

• Mac python3 -m pip install appdirs
• Other systems pip install appdirs

Images:

• There is a big and small version of each image. The big images are used to produce the small images.
• If you change the sizes of the small images, change minesweeper.py to use the new size.
• When resizing a big image to make a small image, make sure that the small image has transparent background.
• Keep images/sources.txt up to date.