README: Mention the name of some debian packages
[paraslash.git] / README
diff --git a/README b/README
index 2c0dc76ddfd52f8da2c3296292c39a90126905f1..b51a8d39cd8ca153c7996f8a6e9dd94f41bd2b03 100644 (file)
--- a/README
+++ b/README
@@ -8,9 +8,8 @@ It contains the following programs:
 
 - para_server (obligatory):
 
-        This server listens on a specified tcp port and accepts the
-        usual commands such as play, stop, pause, next. However, there
-        are many more commands.
+       This server listens on a tcp port and accepts commands such as
+       play, stop, pause, next. However, there are many more commands.
 
        For audio streaming, at least one sender must be activated.
        At the moment, paraslash contains two internal senders:
@@ -25,20 +24,19 @@ It contains the following programs:
        All senders have the same set of commands that allow to
        control the access permissions of the stream.
 
-       para_server needs a database tool to work, mainly to determine
-       which song to stream next. There are two database tools
-       available: mysql and random. The former is recommended as
-       the random database tool is only meant as a fallback and
-       as a starting point for people that want to write their own
-       database tool for paraslash.
+       para_server needs a "database tool" to work, mainly to
+       determine which song to stream next. There are three such
+       tools available: random, plm and mysql. The former chooses
+       audio files randomly and plm, the playlist manager, can handle
+       playlists. Both are always supported.
 
-       The mysql database tool connects to a mysql server which
-       holds information on your audio files. It has several unusual
-       features, see README.mysql for details.
+       The (optional) mysql database tool connects to a mysql server
+       which holds information on your audio files. It has several
+       unusual features, see README.mysql for details.
 
 - para_client (obligatory):
 
-        The client program to connect to para_server.
+       The client program to connect to para_server.
 
 - para_recv (optional)
 
@@ -59,6 +57,7 @@ It contains the following programs:
 - para_play (optional)
 
        A small wav/raw player for alsa.
+       Debian package: libasound2-dev
 
 - para_audiod (optional, but recommended):
 
@@ -165,6 +164,8 @@ If you want to stream ogg vorbis files you'll need:
 
                http://www.xiph.org/downloads/
 
+Debian packages: libogg-dev libvorbis-dev
+
 Note that para_audiod still works even if neither mp3 nor ogg support
 was compiled in. You'll have to use the --no_default_filters option
 in this case (and e.g. "mpg123 -" as the stream write command).