Initial commitHEADmaster

1 files changed, 26 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..bc8a7b7
--- /dev/null
+++ b/README.org
@@ -0,0 +1,26 @@
+#+title: MPD Notify
+
+A simple script that listens to an =mpc idleloop= and sends a notification whenever the playing state of MPD changes. This tries to show the album art along with the notification as long as there is one of these files present in the album's directory:
+
+- =cover.jpg=
+- =cover.jpeg=
+- =cover.png=
+- =folder.jpg=
+- =folder.jpeg=
+- =folder.png=
+
+* Requirements
+
+This script needs [[https://musicpd.org/clients/mpc/][mpc]], [[https://gitlab.gnome.org/GNOME/libnotify][libnotify]] and [[https://www.zsh.org/][zsh]].
+
+* Installation
+
+Put the =mpd-notify= script anywhere in your =$PATH=.
+
+* Usage
+
+Run the =mpd-notify= script without arguments. This script assumes that your MPD music directory is =$HOME/music= and any file path it gets from MPD will be relative to that.
+
+Since this is meant to keep running in the background, you probably want it to do so by calling it as:
+
+: mpd-notify &