index f2deb592048db74ef81edc029316d3274a97d262..c7d4ba3e8ca458ca4f49700e8fd74894e1425a03 100644 (file)
--- a/README
+++ b/README
-mpc-ncurses 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, mpc-ncurses connects to localhost:2100. 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.
- $ mpc-ncurses --host=musicserver --port=44000
+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
-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
+How to compile and install ncmpc
+-------------------------------------------------------------------------------
+See the INSTALL file.
-Read more about MPD on http://www.musicpd.org
-Read more about mpc-ncurses on http://hem.bredband.net/kaw/apps/mpc-ncurses
+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
+-------------------------------------------------------------------------------
+Home page and download:
+ http://www.musicpd.org/clients/ncmpc/
+MPD's home page:
+ http://www.musicpd.org/
+Bug tracker:
+ http://bugs.musicpd.org/
+Forum:
+ http://forum.musicpd.org/