Introduce the new nonblock API.

[paraslash.git] / REQUIREMENTS

diff --git a/REQUIREMENTS b/REQUIREMENTS
index a83c4f39b9571e108200a992852cf73cee4650fc..a9aedcda7aa95eaaf510a2c8414f8e8fb781bc9e 100644 (file)
--- a/REQUIREMENTS
+++ b/REQUIREMENTS
@@ -1,35 +1,42 @@
 Requirements
 ============
 
 Requirements
 ============
 

-In any case you need
+In any case you'll need

 
 

-       - gcc, the gnu compiler collection (shipped with distro): gcc-3.3
+       - *libosl*, the object storage layer: Used by para_server. It is
+         available from http://git.tuebingen.mpg.de/osl. Alternatively,
+         execute "git clone git://git.tuebingen.mpg.de/osl".
+
+       - *gcc*, the gnu compiler collection (shipped with distro): gcc-3.3

          or newer is required.
          or newer is required.

-       - gnu make (shipped with disto, might be called gmake)
-       - 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
+
+       - *gnu make* (shipped with disto, might be called gmake on BSD systems)
+
+       - *bash* (most likely already installed)
+
+       - *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/
          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)
+
+       - *help2man* (for man page creation) ftp://ftp.gnu.org/pub/gnu/help2man

 
 Optional features:
 
        - *mp3*: The mp3 decoder of para_filter is based on libmad:
 
 Optional features:
 
        - *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.
-
-         For version 2 id3 tag support, you'll need libid3tag which
-         is also available through the above link. Without libid3tag,
-         only version 1 tags are recognized.
-
+         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.
 
          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
        - *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


@@ -37,12 +44,8 @@ Optional features:
 
        - *aac*:
          For aac files (m4a) you'll need libfaad. Get it at
 
        - *aac*:
          For aac files (m4a) you'll need libfaad. Get it at

-         http://www.audiocoding.com/modules/wiki/?page=AAC
-
-       - *ortp*:
-         If you intend to use the optional ortp streamer, you'll
-         need libortp which is contained in the linphone source code:
-         http://www.linphone.org/index.php/eng
+         http://www.audiocoding.com/.
+         Debian package: libfaad-dev.

 
        - On Linux, you'll need to have ALSA's development package
          installed. The Debian package is called libasound2-dev.
 
        - On Linux, you'll need to have ALSA's development package
          installed. The Debian package is called libasound2-dev.


@@ -55,3 +58,4 @@ Hacking the source:
        - grutatxt http://www.triptico.com/software/grutatxt.html
        - doxygen http://www.stack.nl/~dimitri/doxygen/
        - global ftp://ftp.gnu.org/pub/gnu/global
        - 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/