add readme
[headphoneindicator.git] / 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 Building
14 ========
15 ::
16
17     $ ./gradlew build
18
19
20 =========================
21 About headphone indicator
22 =========================
23
24 Source code
25 ===========
26 Headphone indicators's source code is available from
27 http://git.cweiske.de/headphoneindicator.git
28 or the `mirror on github`__.
29
30 __ https://github.com/cweiske/headphoneindicator
31
32
33 License
34 =======
35 Headphone indicator is licensed under the `GPL v3 or later`__.
36
37 __ http://www.gnu.org/licenses/gpl.html
38
39
40 Author
41 ======
42 Headphone indicator was written by `Christian Weiske`__.
43
44 __ http://cweiske.de/
45