← Back to ratslair.com
aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f73132a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Mine Sweeper
+
+A Minesweeper clone in C and SDL2, and the project where recursive flood-fill finally clicked for me.
+
+A 10x10 board gets seeded with 15 mines, each tile counts the mines in its own 3x3 neighborhood, and clicking an empty tile (zero neighboring mines) sets off a small recursive reveal that keeps opening neighbors until it runs into a ring of numbered tiles on every side. Watching that cascade unfold correctly for the first time, opening up a whole empty region from a single click, was the fun part of this one.
+
+There's also a chording shortcut that reveals every unflagged tile around the one you're hovering, for clearing a region in one go once you've flagged its mines.
+
+## Controls
+
+- Left click — reveal a tile
+- Right click — flag/unflag a tile
+- `Space` — chord (reveal all unflagged neighbors of the hovered tile)
+
+## Building
+
+Needs SDL2 and SDL2_ttf.
+
+```sh
+make
+./mine_sweeper
+```
+
+## License
+
+GPLv3 — see `LICENSE`.