README.rst

   1 *******************
   2 Headphone indicator
   3 *******************
   4 Android app that shows a notification icon in the status bar when
   5 headphones are plugged into the phone.
   6
   7 The app aims to be a tiny as possible.
   8
   9 Runs on Android 4.4+.
  10
  11
  12 ===================
  13 Why was it written?
  14 ===================
  15 I wrote the headphone indicator app because I was immensely unsatisfied
  16 with apps like `susomena's Headphones Indicator`__ which are over
  17 2 MiB in size, but 99% of their code is only related to advertisement.
  18
  19 My task was to show that you can make it much, much better.
  20
  21 __ https://play.google.com/store/apps/details?id=com.susomena.headphonesindicator
  22
  23
  24 ========
  25 Building
  26 ========
  27 ::
  28
  29     $ ./gradlew build
  30
  31
  32 =========================
  33 About headphone indicator
  34 =========================
  35
  36 Source code
  37 ===========
  38 Headphone indicators's source code is available from
  39 http://git.cweiske.de/headphoneindicator.git
  40 or the `mirror on github`__.
  41
  42 __ https://github.com/cweiske/headphoneindicator
  43
  44
  45 License
  46 =======
  47 Headphone indicator is licensed under the `GPL v3 or later`__.
  48
  49 __ http://www.gnu.org/licenses/gpl.html
  50
  51
  52 Author
  53 ======
  54 Headphone indicator was written by `Christian Weiske`__.
  55
  56 __ http://cweiske.de/
  57