/README
#####################################
README - Practical Music Search v0.42
#####################################
Copyright (C) 2006-2010 Kim Tore Jensen <kimtjen@gmail.com>.
The program homepage is <http://pms.sourceforge.net>.
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
********************
$ ./configure && make && sudo make install
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
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
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"
Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/pms
Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/pms
You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a
pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master