Add README

Is part of Issue #4, but there should still be attributions in-app
Tadaboody · Nov 19, 2018 · f89dc4e · f89dc4e
1 parent c29fda2
commit f89dc4e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.github/MineSweeper.gif b/.github/MineSweeper.gif
diff --git a/.github/app_icon.png b/.github/app_icon.png
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# ![icon](./.github/app_icon.png) Minesweeper 
+### The only good Minesweeper Android App
+
+__Demo:__
+![minesweeper gif](./.github/MineSweeper.gif)
+
+### What's different about it?
+The controls! as if you were playing on your computer with only right clicks:
+- Every tap on a hidden block flags it
+- Every tap on a number reveals all its neighbors - **if they are properly flagged**
+- Holding a hidden block always reveals it
+
+## Contributors:
+- Huge thanks to [@NiteAx](https://github.com/NiteAx) for supplying the art for the mine tile and app icon!
+- The rest of the assets for tiles were supplied by Kazukiokumura, under the Creative Commons Attribution-Share Alike all of them can be found on [wikimedia](https://commons.wikimedia.org/wiki/Category:Minesweeper)
+- The [ZoomLayout Library](https://github.com/natario1/ZoomLayout) which this project heavily relies on