added README.md info

master
kirbylife 2019-06-18 15:07:23 -05:00
parent 422ab6e207
commit db1bf77482
2 changed files with 21 additions and 1 deletions

View File

@ -1,5 +1,5 @@
[package]
name = "RustSweeper"
name = "rust_sweeper"
version = "0.1.0"
authors = ["kirbylife <gabriel13m@gmail.com>"]
edition = "2018"

View File

@ -1,2 +1,22 @@
# rust_sweeper
Minesweeper made with rust and ncurses
## Dependencies
- ncurses
- rand
## How to execute
Simply execute
```
cargo run
```
## Controls
|key|action|
|---|---|
|Arrow keys|move arround the board|
|F|flag a box|
|Space|reveal a box|
|q|exit|