###############################
README - Practical Music Search
###############################

Copyright (C) 2006-2015 Kim Tore Jensen <kimtjen@gmail.com>.

The source code and latest version can be found at Github:
<https://github.com/ambientsound/pms>.

Practical Music Search is a ncurses-based client for MPD. It has a command line
interface much like Vim, and supports custom colors, layouts, and key bindings.
PMS aims to be accessible and highly configurable.


	Table of Contents
*************************

1. Compiling
2. Requirements
3. Configuration
4. Reporting bugs
	


	1. Compiling
********************

From a release tarball, run:

$ ./configure && make && sudo make install

From the Git tree, run:

$ ./rebuild.sh

See INSTALL file for detailed instructions.


	2. Requirements
***********************

PMS is a client for the Music Player Daemon (http://musicpd.org). You need to 
have MPD installed and working before using PMS, but not neccessarily on the
same machine.

This client works best with recent MPD versions (>= 0.15.0).

PMS depends on the following libraries:

ncurses (>= 5.0)
glib2 (>= 2.0)
boost_regex (>= 1.36.0) to enable regular expression searches

On a Debian-based system, you can run:

$ sudo apt-get install build-essential intltool libncursesw5-dev libglib2.0-dev


	3. Configuration
************************

Consult the man page for configuration options.

There are example configuration files in the "examples" directory.

If there is no man page available on your system, you can read the manual page 
online at <http://pms.sourceforge.net/pms.1.html>.

Hint: type ':help' from within PMS to show a list of all current keyboard
bindings.


	4. Reporting bugs
*************************

Please use the bug tracker at this URL:

http://sourceforge.net/apps/trac/pms