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 Usage
  14 =====
  15 After installation, you have to start the application `at least once`__.
  16 Then it will be running as a background service that shows the headset
  17 status icon whenever the headphones are plugged in.
  18
  19 You can close the app, and the status icon will still work - even after
  20 rebooting your phone.
  21
  22 __ http://stackoverflow.com/a/8535062/282601
  23
  24
  25 ===================
  26 Why was it written?
  27 ===================
  28 I wrote the headphone indicator app because I was immensely unsatisfied
  29 with apps like `susomena's Headphones Indicator`__ which are over
  30 2 MiB in size, but 99% of their code is only related to advertisement.
  31
  32 My task was to show that you can make it much, much better.
  33
  34 __ https://play.google.com/store/apps/details?id=com.susomena.headphonesindicator
  35
  36
  37 ========
  38 Building
  39 ========
  40 ::
  41
  42     $ ./gradlew build
  43
  44
  45 =========================
  46 About headphone indicator
  47 =========================
  48
  49 Source code
  50 ===========
  51 Headphone indicators's source code is available from
  52 http://git.cweiske.de/headphoneindicator.git
  53 or the `mirror on github`__.
  54
  55 __ https://github.com/cweiske/headphoneindicator
  56
  57
  58 License
  59 =======
  60 Headphone indicator is licensed under the `GPL v3 or later`__.
  61
  62 __ http://www.gnu.org/licenses/gpl.html
  63
  64
  65 Author
  66 ======
  67 Headphone indicator was written by `Christian Weiske`__.
  68
  69 __ http://cweiske.de/
  70