Mention USB and headset features in README
authorChristian Weiske <[email protected]>
Wed, 28 Aug 2024 18:32:43 +0000 (20:32 +0200)
committerChristian Weiske <[email protected]>
Wed, 28 Aug 2024 19:08:17 +0000 (21:08 +0200)
README.rst

index 010a152ae0656e9681168e737d6f4e6db0a024e0..a3e00d93c75ffeccb8b25c9852dc547e125668d5 100644 (file)
@@ -4,6 +4,9 @@ Headphone indicator
 Android app that shows a notification icon in the status bar when
 headphones are plugged into the phone.
 
+Shows a different icon when a headset is attached.
+Both 3.5mm audio jack devices and USB headphones/headsets are supported.
+
 The app aims to be a tiny as possible.
 
 Runs on Android 4.4+.
@@ -54,16 +57,17 @@ Building
 ========
 ::
 
-    $ 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.
+    $ ./gradlew build
 
 
 Releasing
 =========
+Modify the version in ``AndroidManifest.xml```.
+
+Disable resource file optimization in ``gradle.properties``:
+
+    android.enableResourceOptimizations=false
+
 Build it normally, then sign the generated package file::
 
     $ gradle assembleRelease