Use installed gradle, not gradlew

[headphoneindicator.git] / README.rst

diff --git a/README.rst b/README.rst
index 06b9d50a1cb51052b19e9337d1b0967ac1fd1fb1..795e3aa1ae8b888ca53781c2148d9b601dcefa66 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -9,6 +9,19 @@ The app aims to be a tiny as possible.
 Runs on Android 4.4+.
 
 
+=====
+Usage
+=====
+After installation, you have to start the application `at least once`__.
+Then it will be running as a background service that shows the headset
+status icon whenever the headphones are plugged in.
+
+You can close the app, and the status icon will still work - even after
+rebooting your phone.
+
+__ http://stackoverflow.com/a/8535062/282601
+
+
 ===================
 Why was it written?
 ===================
@@ -26,7 +39,35 @@ Building
 ========
 ::
 
-    $ ./gradlew build
+    $ gradle build
+
+Note that AndroidStudio 1.5.1 does not detect the gradle configuration correctly
+and produces ``.apk`` files much larger than necessary, with duplicated files.
+
+``gradle`` on command line does it correctly, though.
+
+
+Releasing
+=========
+Build it normally, then sign the generated package file::
+
+    $ gradle assembleRelease
+
+To sign the release with your key, put the path to the signing configuration
+file into ``gradle.properties``::
+
+    signingconfigfile=/path/to/signing-config.gradle
+
+The signing configuration file should look like shown in
+`Handling signing configs with Gradle`__
+
+__ https://www.timroes.de/2013/09/22/handling-signing-configs-with-gradle/
+
+
+Dependencies
+============
+* gradle 2.12 (earlier will probably work, too)
+* Android SDK 19
 
 
 =========================