diff --git a/Cargo.toml b/Cargo.toml index 4fb9a7b..c521558 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "RustSweeper" +name = "rust_sweeper" version = "0.1.0" authors = ["kirbylife "] edition = "2018" diff --git a/README.md b/README.md index f00fcfa..42f8156 100644 --- a/README.md +++ b/README.md @@ -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|