summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRasmus Steinke <rasi@xssn.at>2014-12-07 10:41:48 +0100
committerRasmus Steinke <rasi@xssn.at>2014-12-07 10:41:48 +0100
commit4910fc21c91709860dba4f6aab10710cff6c3df6 (patch)
treee0a860ff62307ca127f370e23d8b644dd3434ee1 /README.md
parente25f65d243ba04837c22ca85a738fa6c62c25950 (diff)
downloadperl-app-clerk-4910fc21c91709860dba4f6aab10710cff6c3df6.tar.gz
perl-app-clerk-4910fc21c91709860dba4f6aab10710cff6c3df6.tar.xz
added installation section
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6a34328..7cf48ad 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,14 @@ see `clerk -h` for all default arguments.
* lastfm-mpd-cli for loving tracks (https://github.com/morendi/lastfm-mpd-cli)
* mpd-sima (for Similar Artists playback)
+# Installation
+
+1. Install dependecies (each binary needs to be in your $PATH)
+2. copy config.example to $HOME/.config/clerk/config and edit it.
+3. run rofi.
+
+For arch linux there is a package in [AUR](https://aur.archlinux.org/packages/clerk-git/)
+
#### A word on album ratings
mpd's sticker database is very limited and only allows stickers to be associated
with files. Originally it was planned to extend stickers for other types too
@@ -50,3 +58,6 @@ Also mpd deletes stickers instantly, when files move or get renamed.
For this reason I keep flat files in directory of the album for both track and
album ratings. With those files and a tiny bash script it's possible to rebuild
the sticker database in very little time.
+
+So if you plan to use ratings, it's a good idea to have music_path option
+in config file. If your music is on a different machine just mount it locally.