Code

keyboard: call wgetch() on main window
[ncmpc.git] / README
diff --git a/README b/README
index af7183eee684ef71b0d4c139eebf1505704537c1..c7d4ba3e8ca458ca4f49700e8fd74894e1425a03 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,49 @@
-ncmpc is a ncurses client for MPD, the Music Player Daemon with an
-interface is inspired by cplay (by Ulf Betlehem).  
 
-The client connects to a MPD running on a machine on the local network.
-By default,  ncmpc  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.
+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
 
-       $ ncmpc --host=musicserver --port=44000
 
 
-Read more about MPD on http://www.musicpd.org
+How to compile and install ncmpc
+-------------------------------------------------------------------------------
 
+See the INSTALL file.
 
 
+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/