Merge branch 'master' into next

[paraslash.git] / REQUIREMENTS

diff --git a/REQUIREMENTS b/REQUIREMENTS
index 0a572b15c72e9f1c01214838ac95e348a9c2b99e..1991737b2817eceab575265133e83153336e675f 100644 (file)
--- a/REQUIREMENTS
+++ b/REQUIREMENTS
@@ -3,42 +3,58 @@ Requirements
 
 In any case you need
 
+       - libosl: If you are compiling from git the osl sources should
+         have been cloned automatically. It is also available for
+         download from http://git.tuebingen.mpg.de/osl. Or run the
+         command "git clone git://git.tuebingen.mpg.de/osl"
        - gcc, the gnu compiler collection (shipped with distro): gcc-3.3
          or newer is required.
        - gnu make (shipped with disto, might be called gmake)
-       - bash
+       - bash (most likely already installed)
+       - A decent version of grep. Solaris' /bin/grep is not good enough,
+         /usr/xpg4/bin/grep is fine though.
        - openssl (needed by server, client): usually shipped with
          distro, but you might have to install the "development package"
          (called libssl-dev on debian systems) as well:
          http://www.openssl.org/
+       - help2man (for man page creation) ftp://ftp.gnu.org/pub/gnu/help2man
        - software mixing, e.g. ALSA and the direct mixing plugin (dmix)
 
 Optional features:
 
-       - *mp3*:
-       The mp3 decoder of para_filter is based on libmad:
-       If you prefer to use the libmad package provided by your
-       distributor, make sure to install the corresponding development
-       package as well.    Otherwise, just download libmad from
-       http://www.underbit.com/products/mad/
-
-       - *ogg vorbis*:
-       For ogg vorbis streams you'll need libogg, libvorbis,
-       libvorbisfile, The corresponding Debian packages are
-       called libogg-dev libvorbis-dev, other distributors chose
-       similar names.  The source of these is also available at
-       http://www.xiph.org/downloads/
+       - *mp3*: The mp3 decoder of para_filter is based on libmad:
+         http://www.underbit.com/products/mad/. If you prefer to
+         use the libmad package provided by your distributor, make
+         sure to install the corresponding development package as
+         well. It is called libmad0-dev on debian-based systems.
+         Note that libmad is not necessary for the server side,
+         i.e. for sending mp3 files.
+
+       - *id3 tags*:
+         For version-2 id3 tag support, you'll need libid3tag which
+         is also available through the above link (alternatively:
+         install package libid3tag0-dev). Without libid3tag, only
+         version one tags are recognized.
+
+       - *ogg vorbis*: For ogg vorbis streams you'll need libogg,
+         libvorbis, libvorbisfile: http://www.xiph.org/downloads/.
+         The corresponding Debian packages are called libogg-dev
+         libvorbis-dev, other distributors chose similar names.
 
        - *aac*:
-       For aac files (m4a) you'll need libfaad. Get it at
-       http://www.audiocoding.com/modules/wiki/?page=AAC
+         For aac files (m4a) you'll need libfaad. Get it at
+         http://www.audiocoding.com/.
+         Debian package: libfaad-dev.
 
-       - *ortp*:
-       If you intend to use the optional ortp streamer, you'll need libortp:
-       http://www.linphone.org/ortp/
+       - On Linux, you'll need to have ALSA's development package
+         installed. The Debian package is called libasound2-dev.
 
 Hacking the source:
 
        - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/
        - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/
-       - grutatxt
+       - git http://git.or.cz/
+       - grutatxt http://www.triptico.com/software/grutatxt.html
+       - doxygen http://www.stack.nl/~dimitri/doxygen/
+       - global ftp://ftp.gnu.org/pub/gnu/global
+       - m4: ftp://ftp.gnu.org/pub/gnu/m4/