Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write up documentation for the app #159

Open
11 tasks
LewisGaul opened this issue Jan 13, 2022 · 1 comment
Open
11 tasks

Write up documentation for the app #159

LewisGaul opened this issue Jan 13, 2022 · 1 comment
Labels
docs good-first-issue Newcomer-friendly issue

Comments

@LewisGaul
Copy link
Owner

LewisGaul commented Jan 13, 2022 •
edited
Loading

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 #99):

  • Split cell mode
  • Probability calculations
  • Custom 'detection' of mines
@LewisGaul LewisGaul added good-first-issue Newcomer-friendly issue docs labels Jan 13, 2022
@LewisGaul
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs good-first-issue Newcomer-friendly issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@LewisGaul