Always write image_name and lyrics_name status output.
[paraslash.git] / REQUIREMENTS
index 0a572b1..ca5040a 100644 (file)
@@ -6,7 +6,7 @@ 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
+       - 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:
@@ -15,30 +15,31 @@ In any case you need
 
 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/
+       - *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.
+         Note that libmad is not necessary for sending mp3 files.
 
-       - *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/
+       - *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.
+         The source of these is also available at
 
        - *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/modules/wiki/?page=AAC
 
        - *ortp*:
-       If you intend to use the optional ortp streamer, you'll need libortp:
-       http://www.linphone.org/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
+       - help2man
+       - doxygen
+       - global