Write up documentation for the app - Githubissues

LewisGaul / minegauler

A clone of the original minesweeper game with many added features

GNU General Public License v3.0

12 stars 8 forks source link

Write up documentation for the app #159

Open LewisGaul opened 2 years ago

LewisGaul commented 2 years ago

Write about how it functions as a classic minesweeper app, and then all of its additional features!

Existing features (also see the changelog):

[ ] Basics, fundamental role as a classic minesweeper app
[ ] Create/save/load boards
[ ] Regular or custom difficulty levels
[ ] Local and remote highscores
[ ] Game completion time predictions
[ ] Change button size, themes
[ ] Drag-select
[ ] Multiple mines per cell

Upcoming features (also see https://github.com/LewisGaul/minegauler/issues/99):

[ ] Split cell mode
[ ] Probability calculations
[ ] Custom 'detection' of mines

LewisGaul commented 2 years ago

I have added a 'features' section to the README (based on the minegauler/files/features.txt file used in-app), but it would still be good to have some more detailed documentation of how each of the features works.