summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <jakob@memeware.net>2018-12-15 09:43:59 -0500
committerJakob L. Kreuze <jakob@memeware.net>2018-12-15 09:43:59 -0500
commit625685b9010a1157664d8f3f68b6884fd34f1b16 (patch)
treebf540683a6272c1543bab60dece76dc9255071fd /README.md
parent91bc2599954fccf47ef020497f63865b990f418f (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 69c9a9e..0aca841 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
# Mines
+
+This is a work-in-progress Android implementation of the single-player puzzle
+video game, "Minesweeper." The code aims to emulate the gameplay of Microsoft
+Minesweeper. (Within reason, of course. It would be very difficult to implement
+chording with the input vocabulary of a mobile device.)
+
+Mines is free software: you can redistribute it and/or modify it under the terms
+of the GNU General Public License as published by the Free Software Foundation,
+either version 3 of the License, or (at your option) any later version.
+
+Mines is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+Mines. If not, see <https://www.gnu.org/licenses/>.
+
+## Building
+
+Assuming that you have the Android SDK properly installed and configured, Mines
+can be built with the following command:
+
+```sh
+./gradlew assembleRelease
+```
+
+This will produce `app/build/outputs/apk/release/app-release-unsigned.apk`. This
+file will need to be signed with `jarsigner` and optimized with `zipalign`
+before it can be installed on an Android device.