Inintial import

[now-playing-d.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..084fda0
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+This is a very simple program which displays one line of text in the
+notification area.
+
+It reads a file (~/tmp/now-playing) every second, and displays the contents in
+the notification area. For best results, make sure there's no newlines in the
+file, and that there's not too much text.
+
+You can build it with this command: make
+
+And install it in your ~/bin with this command: make install
+
+This program is licensed under the GNU GPLv3+.
+
+This download also contains a copy of eggtrayicon by Anders Carlsson, which is
+licensed under the GNU LGPLv2+