![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 7367b13f03390d14f10a5612cb14a46c91a7252b..4148790dcb02e5653ad560dc102c610d7f3dbd14 100644 (file)
--- a/README
+++ b/README
-ncmpc is a ncurses client for MPD, the Music Player Daemon.
-The client connects to a MPD running on a machine on the local network.
-By default, ncmpc connects to localhost:2100. This can be
+
+Overview
+------------------------------------------------------------------------------
+ncmpc is a curses client for the Music Player Daemon (MPD). ncmpc connects to
+a MPD running on a machine on the local network, and controls this with an
+interface inspired by cplay.
+
+Music Player Daemon (MPD) allows remote access for playing music (MP3,
+Ogg Vorbis, FLAC, AAC, and wave files) and managing playlists. MPD is
+designed for integrating a computer into a stereo system that provides
+control for music playback over a local network. Read more at musicpd.org
+
+
+
+How to compile and install ncmpc
+-------------------------------------------------------------------------------
+
+Requirements:
+ * ncurses
+ * glib-2.2 (2.4 for NLS support)
+
+Download the ncmpc source code, then:
+ $ tar zxvf ncmpc-x.y.z.tar.gz
+ $ cd ncmpc-x.y.z
+ $ ./configure
+ $ make
+ $ make install
+
+or if you are starting from the subversion checkout:
+ $ svn co https://svn.musicpd.org/ncmpc/trunk ncmpc
+ $ cd ncmpc
+ $ ./autogen.sh
+ $ make
+ $ make install
+
+
+Upgrading to ncmpc-0.11.0
+------------------------------------------------------------------------------
+The syntax for the configuration file (~/.ncmpc/config) has changed, view the
+manual page or the sample configuration file for details.
+
+The old key binding to the select command (space,a) will result in a
+conflict as the a key is used for the new add command in 0.11.0. The easy
+solution is to delete your old key bindings (~/.ncmpc/keys), but you can use
+the built in key editor to solve any key conflicts.
+
+
+
+Usage
+-------------------------------------------------------------------------------
+ncmpc connects to a MPD running on a machine on the local network.
+By default, ncmpc connects to localhost:6600. This can be
changed either at compile-time, or by exporting the MPD_HOST and
MPD_PORT environment variables, or by the command line options --host
and --port.
$ ncmpc --host=musicserver --port=44000
+For more information please view ncmpc's manual page.
+
+
+
+
+Web Page, Forums and Bug Reports
+-------------------------------------------------------------------------------
+ * Read more about ncmpc & MPD on http://www.musicpd.org
+ * a ncmpc forum exists at musicpd.org - http://www.musicpd.org/forum
+ * report bugs at musicpd.org - http://www.musicpd.org/mantis/
+
-Note!
-If your are connecting to a MPD server with a version newer than 0.9.x
-and you dont use utf-8 as your charset set the CHARSET enviroment variable.
- $ export CHARSET=ISO_8859-1
+-------------------------------------------------------------------------------
+$Id$
-Read more about MPD on http://www.musicpd.org