From d021fcf40f0900a3dfb1f1e162ed25d61085ea5c Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Wed, 5 Oct 2016 23:32:17 +0200 Subject: add basic documentation about configuration file --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6025af8..5a36b9e 100644 --- a/README.md +++ b/README.md @@ -69,16 +69,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 -- cgit v1.2.3-54-g00ecf