Updating INSTALL

git-svn-id: https://svn.musicpd.org/mpd/trunk@4706 09075e82-0dd4-0310-85a5-a0d7c8717e4f

1 files changed, 57 insertions, 46 deletions

diff --git a/INSTALL b/INSTALL
index ca1f9635b..18ac3852e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,43 +1,66 @@
                        Music Player Daemon (MPD) - INSTALL
 
-Requirements
-------------
+Optional Output Dependencies
+----------------------------
 
-libao - http://www.vorbis.com/download_unix.psp
-(This comes with most/all distributions. Make sure you have both
-the ao libs and development packages for your distribution installed.
-For Red Hat 8.0, the necessary packages are: libao and libao-devel)
+You will need at least one of these to compile MPD.
 
-zlib - http://www.gzip.org/zlib
-(This comes with all distributions.  Make sure you have bot the zlib libs
-and development packages for your distribution installed.  For Red hat,
-the necessary packages are: zlib and zlib-devel)
+Most of these are available as packages on major distributions.  Be sure to
+install both the library package as well as the development package.
 
-Optional
---------
+AO - http://www.xiph.org/ao/
+A portable library that abstracts many audio output types as one API.  Should
+be used only if there is no native plugin available or if the native plugin
+doesn't work.  You will need libao.
+
+ALSA - http://www.alsa-project.org/
+The Advanced Linux Sound Architecture.  Recommended audio output if you use
+Linux.  You will need libasound.
+
+PulseAudio - http://www.pulseaudio.org/
+An advanced sound daemon.  You will need libpulse.
+
+libshout - http://www.icecast.org/
+For streaming to an Icecast or Shoutcast server.
+
+Optional Input Dependencies
+---------------------------
+
+You will need at least one of these to compile MPD.
+
+Most of these are available as packages on major distributions.  Be sure to
+install both the library package as well as the development package.
+
+MAD - http://www.underbit.com/products/mad/
+For MP3 support.  You will need libmad, and optionally libid3tag if you want
+ID3 tag support.
 
 Ogg Vorbis - http://www.xiph.org/ogg/vorbis/
-(This comes with most/all distributions.  Make sure you have both the
-ogg and vorbis libs as well as the development packages for your
-distribution installed.  For Red Hat 8.0, the necessary packages are:
-libogg, libogg-devel, libvorbis, and libvorbis-devel).
+For Ogg Vorbis support.  You will need libogg and libvorbis.
+
+FLAC - http://flac.sourceforge.net/
+For FLAC support.  You will need version 1.1.0 or higher of libflac.
 
-Flac - http://flac.sf.net
-For Flac support, you need Flac 1.1.0 or greater.
+OggFLAC - http://www.xiph.org/ogg/vorbis/ and http://flac.sourceforge.net/
+For OggFLAC support.  You will need liboggflac, which can be built from the
+FLAC sources if libogg is already installed.
 
-FAAD2 - http://faac.sf.net
-For MP4/AAC support.
+Audio File - http://www.68k.org/~michael/audiofile/
+For WAVE, AIFF, and AU support.  You will need libaudiofile.
 
-Audiofile - http://www.68k.org/~michael/audiofile/
-For wave, aiff, and au support.
+FAAD2 - http://www.audiocoding.com/
+For MP4/AAC support.  You will need libmp4ff.
 
-libmikmod - http://mikmod.raphnet.net/
-For Mod support.
+libmpcdec - http://www.musepack.net/
+For Musepack support.
+
+MikMod - http://mikmod.raphnet.net/
+For MOD support.  You will need libmikmod.
 
 Download
 --------
 
-Get the latest release from of MPD from http://www.musicpd.org
+Get the latest release from of MPD from <http://www.musicpd.org/>.
 
 Compile
 -------
@@ -46,6 +69,10 @@ Compile
 
 $ tar zxvf mpd-x.x.x.tar.gz
 
+or
+
+$ tar jxvf mpd-x.x.x.tar.bz2
+
 2) change to directory created
 
 $ cd mpd-x.x.x
@@ -68,24 +95,6 @@ Run
 ---
 
 1) run mpd:
-<port>: port number daemon listens on (if running as a user, this should be 
-	greater than 1024)
-<mp3 directory>:  directory containing mp3's
-<playlist directory>: directory where playlists will be stored (and .mpddb will
-	be placed)
-<mpd log>: log file for mpd
-<mpd err>: error log file for mpd
-
-$ mpd <port> <mp3 directory> <playlist directory> <mpd log> <mpd err>
-
-example where mpd executable is in mpd-x.x.x directory:
-$ mpd-x.x.x/mpd 6600 mp3 playlists mpd.log mpd.err
-
-Note: The first time you run mpd, it will "explore" your mp3 directory for
-mp3's.
-
-Also, mpd can alternatively use config file.  In this case,
-run mpd like this:
 
 $ mpd <config file>
 
@@ -97,12 +106,14 @@ $ mpd playlists/.mpdconf
 
 A sample config file is included with the source of MPD, mpdconf.example .
 
+Note: The first time you run mpd, it will "explore" your mp3 directory for
+mp3's.
+
 Using MPD
 ---------
 
-You can download a web interface (phpMp) to MPD at 
-http://www.musicpd.org .
+You can download a web interface (phpMp) to MPD at <http://www.musicpd.org/>.
 
-Also, several other clients can be found for MPD at http://www.musicpd.org .
+Also, several other clients can be found for MPD at <http://www.musicpd.org/>.
 
 MPD can be interfaced directly using telnet (see COMMANDS, if you are brave).