diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..8aea7d0 --- /dev/null +++ b/readme.md @@ -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) \ No newline at end of file diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..3936387 Binary files /dev/null and b/screenshot.png differ