summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRasmus Steinke <rasi@xssn.at>2017-08-03 17:29:10 +0200
committerRasmus Steinke <rasi@xssn.at>2017-08-03 17:29:10 +0200
commit717d3d363105ef1f5f2b878d2ba75f7316975af6 (patch)
treeb5107023ea7d2a0bf7f8ce845bc788c7810850e9 /README.md
parent554b7fd2e23890f9b381ea1b7a3f3933624a8b85 (diff)
downloadclerk-717d3d363105ef1f5f2b878d2ba75f7316975af6.tar.gz
clerk-717d3d363105ef1f5f2b878d2ba75f7316975af6.tar.bz2
remove non-needed files
Diffstat (limited to 'README.md')
-rw-r--r--README.md65
1 files changed, 0 insertions, 65 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 3bf5926..0000000
--- a/README.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# clerk
-
-MPD client using bash and rofi
-
-# Screenshot (V3)
-![Screenshot](images/clerk_multi_keys.jpg)
-
-# Features:
-
-* Play random Album/Tracks
-* Add/Insert/Replace Albums/Songs
-* Manage current Queue
-* Locate Album/Track in Library
-* Toggle scrobbling
-* Love current Song on last.fm
-* Rate Albums/Tracks
-* Load rated Albums/Tracks
-* Play Similar Songs
-* Control mpd options
-* Customizable Hotkeys
-
-Written completely functional, nearly every option is accessible
-from command line.
-For example `clerk --random track` will play random songs.
-
-see `clerk -h` for all default arguments.
-
-From every database related menu it's possible to add/insert/replace one or multple entries.
-For this to work, you need a recent rofi build from git.
-
-# Dependencies:
-
-* rofi (https://github.com/DaveDavenport/rofi)
-* mpc (at least 0.26, for working albumlist sorted by mtime 0.27 is needed)
-* python-mpd2 (https://github.com/Mic92/python-mpd2)
-* a version of column with `-s` support.
-* perl
-
-# Optional Dependencies
-
-* lastfm-mpd-cli for loving tracks (https://github.com/morendi/lastfm-mpd-cli)
- (Not needed when using mpdas instead of mpdscribble)
-* mpd-sima (for Similar Artists playback)
-
-# Installation
-
-1. Install dependencies (each binary needs to be in your $PATH)
-2. Copy config.clerk to $XDG_CONFIG_HOME/clerk/config if $XDG_CONFIG_HOME is
- set, otherwise copy it to $HOME/.config/clerk/config and edit it.
-3. Copy clerk and clerk_helper to $PATH
-4. Run clerk
-
-For arch linux there is a package in [AUR](https://aur.archlinux.org/packages/clerk-git/)
-
-A completion script is provided for the zsh shell. To use it, copy the
-`completion/_clerk` file of this repository somewhere in the `$fpath`
-environment variable of zsh.
-
-# FAQ
-1. It's not working properly
- Make sure to have your files tagged properly. You need: `albumartist`, `artist`, `album`, `date`, `tracknumber`, `title` tags.
-2. mpd says 'connection closed by server'
- increase your `max_output_buffer_size` in mpd.conf
- I requested a chunked protocol feature [here](http://bugs.musicpd.org/view.php?id=4488)
- (which got closed - no fixable)