add readme

This commit is contained in:
Alexander Bass 2023-04-03 16:55:57 -04:00
parent 17d3042997
commit 7e1acd5b8b
2 changed files with 21 additions and 0 deletions

21
readme.md Normal file
View file

@ -0,0 +1,21 @@
# Minesweeper CLI
This is an implementation of the classic game minesweeper using the command line as an interface.
## To run this program
```Bash
cargo run
```
or use one of the provided executables in the releases.
## How to play
Run the program and select the size of the minefield, or press enter to go with the default.
To reveal tiles, simply type a command in the format of `x,y` such as `3,5`
To flag tiles, prefix that command with an `f`, like `f3,5`
To quit, use `CTRL+C` or the `q` command.
## Screenshots
!["Screenshot of gameplay"](screenshot.png)

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB