aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2016-10-05 23:54:20 +0200
committerGravatar Christian Hesse <mail@eworm.de>2016-10-05 23:54:20 +0200
commit071597337d00070b44e67fcc1458bcf1f5f343a6 (patch)
treedccce6c41dbab8b9a78c777463377e70aeb04eac /README.md
parent90b01922ea7622de0eab2216912445040389ed5c (diff)
parent86aaf24691e1d9035a3db86e2df03c49e7675d6c (diff)
downloadmpd-notification-071597337d00070b44e67fcc1458bcf1f5f343a6.tar.gz
mpd-notification-071597337d00070b44e67fcc1458bcf1f5f343a6.tar.zst
Merge branch 'config'
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 22 insertions, 5 deletions
diff --git a/README.md b/README.md
index 6025af8..2ee1cb5 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ Requirements
To compile and run `mpd-notification` you need:
+* [iniparser](http://ndevilla.free.fr/iniparser/)
* [libav](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/)
* [libnotify](http://library.gnome.org/devel/notification-spec/)
* [libmpdclient](http://www.musicpd.org/libs/libmpdclient/)
@@ -69,16 +70,32 @@ or `systemctl --user enable mpd-notification`.
* *-v*: verbose output
* *-V*: print version information
+Configuration
+-------------
+
+Configuration options can be read from a configuration file. `mpd`
+tries to read `~/.local/mpd-notification.conf`, which is expected to
+look like this:
+
+ host = localhost
+ port = 6600
+ music-dir = /srv/media/music/
+ scale = 200
+ timeout = 20
+
+Unused options can be commented or removed completely.
+
Artwork
-------
`mpd` does not provide any information where it finds its music files. To make
`mpd-notification` display album artwork you need to tell it where to look for
-artwork. You can do that by exporting `XDG_MUSIC_DIR` to your environment or by
-specifying `-m` or `--music-dir` on the command line. `mpd-notification` reads
-album artwork from `mp3` files, otherwise an image file containing the artwork
-needs to be placed in the same directory as the media file and named
-`cover.jpg`, `cover.png`, `folder.jpg` or `folder.png`.
+artwork. You can do that by exporting `XDG_MUSIC_DIR` to your environment, by
+specifying `-m` or `--music-dir` on the command line or by setting `music-dir`
+in configuration file. `mpd-notification` reads album artwork from `mp3`
+files, otherwise an image file containing the artwork needs to be placed
+in the same directory as the media file and named `cover.jpg`,
+`cover.png`, `folder.jpg` or `folder.png`.
### Upstream