summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRasmus Steinke <rasi@xssn.at>2014-07-24 21:54:00 +0200
committerRasmus Steinke <rasi@xssn.at>2014-07-24 21:54:00 +0200
commitee8cd8c59248602651c7527865f4f42a5564ca19 (patch)
tree5c3af98cfd57c4fe86f88b99656bc05ef7a4c153 /README.md
parentc770833d4ea240bba015c48fc872caa464db363b (diff)
downloadperl-app-clerk-ee8cd8c59248602651c7527865f4f42a5564ca19.tar.gz
perl-app-clerk-ee8cd8c59248602651c7527865f4f42a5564ca19.tar.xz
added README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4401955
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# clerk - the only mpd client UI that needs typing
+
+clerk uses dmenu (or rofi) to draw a menu which lets you
+manage your mpd server.
+
+Functions:
+
+* Play random album
+* Play x random tracks
+* Browse Library (Artist > Album > Tracks)
+* Show current Playback Queue
+* Show Albums/Tracks by currently playing Artist
+* Enable or disable scrobbling (with support for remote mpdscribble)
+* Love current song on lastfm
+* Rate albums (using rating.txt in album folder - needs local access to
+* directories)
+* Load rated album
+* Rate tracks (stored in comment tag - needs local access to files)
+* Control mpd options (modes, replaygain, crossfade)
+* Lookup artist/album/lyrics in webbrowser
+
+
+# Dependencies:
+
+* dmenu2 (https://bitbucket.org/melek/dmenu2) OR
+* rofi (https://github.com/DaveDavenport/rofi)
+* mpc (will get completely replaced with mppc, once its finished)
+* mppc (https://github.com/carnager/mppc)
+
+
+# Optional Dependencies
+
+* python-eyed3 (for track ratings)
+* metaflac (for track ratings)
+* surfraw (for lookup)