From ee8cd8c59248602651c7527865f4f42a5564ca19 Mon Sep 17 00:00:00 2001 From: Rasmus Steinke Date: Thu, 24 Jul 2014 21:54:00 +0200 Subject: added README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md (limited to 'README.md') 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) -- cgit v1.2.3-24-g4f1b