Change doxygen file description from dbtool to selector

[paraslash.git] / README

diff --git a/README b/README
index 967655fc196e82bd51443d3f5c588491480e8fa3..95410014c33d228b4ea2516ec0117fe846f8a268 100644 (file)
--- a/README
+++ b/README
@@ -8,9 +8,8 @@ It contains the following programs:
 
 - para_server (obligatory):
 
 
 - 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:
 
        For audio streaming, at least one sender must be activated.
        At the moment, paraslash contains two internal senders:


@@ -25,19 +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.
 
        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 dopey. The former is recommended as dopey
-       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 an  "audio file selector" to work, mainly to
+       determine which song to stream next. There are three selectors
+       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 selector 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):
 
 
 - para_client (obligatory):
 

-        The client program to connect to para_server.
+       The client program to connect to para_server.

 
 - para_recv (optional)
 
 
 - para_recv (optional)
 


@@ -58,6 +57,7 @@ It contains the following programs:
 - para_play (optional)
 
        A small wav/raw player for alsa.
 - para_play (optional)
 
        A small wav/raw player for alsa.

+       Debian package: libasound2-dev

 
 - para_audiod (optional, but recommended):
 
 
 - para_audiod (optional, but recommended):
 


@@ -164,6 +164,8 @@ If you want to stream ogg vorbis files you'll need:
 
                http://www.xiph.org/downloads/
 
 
                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).
 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).


@@ -209,9 +211,9 @@ Distribution of paraslash is covered by the GNU GPL. See file COPYING.
 
 LIMITATIONS:
 ~~~~~~~~~~~~
 
 LIMITATIONS:
 ~~~~~~~~~~~~

-The mysql database tool assumes that the basenames of your audio files
-are unique. If this is not the case, don't use this database tool,
-rename your files, or create your own database tool.
+The mysql selector assumes that the basenames of your audio files are
+unique. If this is not the case, don't use this selector, rename your
+files, or create your own one.

 
 THE AUTHOR:
 ~~~~~~~~~~~
 
 THE AUTHOR:
 ~~~~~~~~~~~