Documentation update and re-ordering.

[paraslash.git] / REQUIREMENTS

diff --git a/REQUIREMENTS b/REQUIREMENTS
new file mode 100644 (file)
index 0000000..0a572b1
--- /dev/null
+++ b/REQUIREMENTS
@@ -0,0 +1,44 @@
+Requirements
+============
+
+In any case you need
+
+       - 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
+       - 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/
+       - 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/
+
+       - *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:
+       http://www.linphone.org/ortp/
+
+Hacking the source:
+
+       - gengetopt: ftp://ftp.gnu.org/pub/gnu/gengetopt/
+       - autoconf: ftp://ftp.gnu.org/pub/gnu/autoconf/
+       - grutatxt