Update Readme for 1.0.0

Nitepone · Jul 23, 2022 · 17da47e · 17da47e
1 parent 7120899
commit 17da47e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,25 @@
-# Minesweeper! In Rust!
+# Minesweeper! In Rust! With a GTK GUI!
 
-Truly a feat that noone has ever attempted, and an original idea. This is a
-project I am doing over a weekend to have some evidence that I can write
-Rust. Maybe also a testbed for playing with Rust features that I want to
-learn more about.
+![image of minrsweeper](./docs/img/minrsweeper.png)
+
+Just a cute little project to play around with. It's a fully featured
+Minesweeper clone.
+
+## Controls
+
+- Left click to Uncover a tile
+- Right click a covered tile to place a flag
+- Right click an uncovered number tile to uncover unflagged neighbors
+
+## Building
+
+### Dependencies
+
+The `gtk3-rs` crate depends on GTK3 development libraries.
+
+- `libgtk-3-dev` on Debian based distros.
+- `gtk3-devel` on Fedora based distros.
+
+### Actually Building
+
+Just, `cargo make`
diff --git a/docs/img/minrsweeper.png b/docs/img/minrsweeper.png