From: Andre Noll <maan@systemlinux.org>
Date: Tue, 23 Oct 2007 17:06:52 +0000 (+0200)
Subject: README/INSTALL/FEATURES cleanup.
X-Git-Tag: v0.3.0~239
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=14fe3da6c11b8085b11ef04f5659a18716a904ff;p=paraslash.git

README/INSTALL/FEATURES cleanup.
---

diff --git a/FEATURES b/FEATURES
index d436518f..a48405cd 100644
--- a/FEATURES
+++ b/FEATURES
@@ -9,7 +9,7 @@ Features
 	* volume normalizer
 	* stream grabbing at any point in the filter chain
 	* stand-alone command line receiver/decoder/normalizer/player
-	* sophisticated audio file selectors (mysql, random, playlist)
+	* sophisticated audio file selector
 	* small memory footprint
 	* command line interface for easy scripting in high-level languages
 	* RSA user authentication
@@ -19,5 +19,5 @@ Features
 	* well documented
 	* complete API-Reference
 	* easily extendible due to its modular design
-	* curses-based interface
+	* curses-based gui
 	* volume fader and alarm clock.
diff --git a/INSTALL b/INSTALL
index 815af1de..330cae6c 100644
--- a/INSTALL
+++ b/INSTALL
@@ -227,10 +227,10 @@ arbitrary commands. There are several flavours of key-bindings:
 	  changed (help, quit, loglevel, version...).
 	- external: Shutdown curses before launching the given command.
 	  Useful for starting other ncurses programs from within
-	  para_gui, e.g. aumix or para_dbadm. Or, use "para_client
-	  mbox" to write a mailbox containing one mail for each file
-	  in the mysql database and start mutt from within para_gui
-	  to browse your collection!
+	  para_gui, e.g.  aumix or dialog scripts. Or, use the mbox
+	  output format to write a mailbox containing one mail for each
+	  (admissible) file the audio file selector knows about. Then
+	  start mutt from within para_gui to browse your collection!
 	- display: Launch the command and display its stdout in
 	  para_gui's bottom window.
 	- para: Like display, but start "para_client <specified
@@ -252,7 +252,7 @@ Attributes
 An attribute is simply a bit which can be set for each audio
 file individually.  Up to 64  different attributes may be
 defined. For example, "pop", "rock", "blues", "jazz", "instrumental",
-"german_lyrics", "speech" whatever. It's up to you how many attributes
+"german_lyrics", "speech", whatever. It's up to you how many attributes
 you define and how you call them.
 
 A new attribute "test" is created by
diff --git a/README b/README
index 457cbafa..d4521bc5 100644
--- a/README
+++ b/README
@@ -30,29 +30,31 @@ or rtp.
 
 It is possible to activate more than one sender simultaneously.
 
-para_server needs an audio file selector to work, mainly to determine
-which audio file to stream next. The following three selectors are
-built in:
+The built-in audio file selector of paraslash is used to manage your
+audio files. It maintains statistics on the usage of all available audio
+files such as last played time, and the number of times each file was
+selected. Its features include
 
-	* The random selector chooses audio files out of a given directory
-	  by random
+	* attributes: Allow fine-grained audio file selection.
 
-	* The playlist selector chooses files from a specified playlist
+	* image table. For storage of e.g. album cover art.
 
-	* The (optional) mysql selector is more involved.  It connects
-	  to a mysql server which holds information on your audio files
-	  and maintains statistics on the available audio files. Audio
-	  file selection works by sending a user-defined sql-query
-	  to the mysql server. This allows rather sophisticated
-	  configurations and is explained in detail in README.mysql.
+	* lyrics table. For storage of lyrics.
 
-It is possible to switch between all supported selectors at any time.
+	* playlist table. Stores arbitrary many playlists.
+
+	* mood mode. Audio file selection works by spcifying mood
+	  methods involving attributes, pattern matching for file names
+	  and more.  This allows rather sophisticated configurations
+	  and is explained in more detail in INSTALL.
+
+	* rename detection. If files are moved or renamed, afs will
+	  recognioze them despite of this change.
 
 Despite of all these features, paraslash is lightweight. The
 stripped binary of para_server with all its features compiled in
-(mysql/random/playlist selector, mp3/ogg/aac support, http/dccp/ortp
-support) is about 120K on i386 under Linux. para_audiod (see below)
-is even smaller.
+mp3/ogg/aac support, http/dccp/ortp support) is about 150K on i386
+under Linux. para_audiod (see below) is even smaller.
 
 ------------------------
 para_client (obligatory)
@@ -135,47 +137,12 @@ the obtained information in an ncurses window. para_gui provides
 key-bindings for the most common commands and new key-bindings can
 be added easily.
 
------------------------
-para_sdl_gui (optional)
------------------------
-
-SDL-based gui. Similar to para_gui but presents its output in an X
-window (fullscreen mode is also available) and can display jpg images
-on a per song basis. para_sdl_gui provides an input prompt to enter
-arbitrary commands. However, it can also be used non-interactively
-(e.g. as a screen saver) via the -i switch.
-
--------------------------------------------------------------------------
-para_krell (optional, only useful in conjunction with the mysql selector)
--------------------------------------------------------------------------
-
-A plugin for gkrellm which shows small pictures of the current song. It
-allows you to launch 27 different commands by clicking in different
-areas of its picture (9 small squares x 3 mouse buttons).
-
 --------------------
 para_fade (optional)
 --------------------
 
 A (Linux-only) alarm clock and volume-fader.
 
--------------------------------------------------------------------------
-para_dbadm (optional, only useful in conjunction with the mysql selector)
--------------------------------------------------------------------------
-
-Very simple curses-based frontend which uses libmenu. Useful for
-quickly changing the attributes of the current song (e.g. from para_gui
-as an external command).
-
---------------------------------------------------------------------------
-para_slider (optional, only useful in conjunction with the mysql selector)
---------------------------------------------------------------------------
-
-A small X application which shows a scrollbar for each attribute
-defined in the mysql database. It creates a stream definition from
-the values of the scrollbars. This allows to smoothly change the mood
-of the given stream without any file editing.
-
 --------------------------
 bash_completion (optional)
 --------------------------
@@ -191,22 +158,14 @@ In any case you need
 
 	- gcc, the gnu compiler collection (shipped with distro): gcc-3.3
 	  or newer is required.
-	- gnu make
+	- 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)
 
-If you want to use the mysql-based audio file selector, you also need
-
-	- mysql-server
-	- mysql-client
-	- libmysqlclient
-
-These are usually shipped with the distro but probably not installed
-by default.
-
 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,
@@ -223,20 +182,6 @@ http://www.audiocoding.com/modules/wiki/?page=AAC
 If you intend to use the optional ortp streamer, you'll need libortp:
 http://www.linphone.org/ortp/
 
-For the optional SDL-based gui, the following packages must be installed:
-
-	- X (usually shipped with distro): http://www.x.org/
-	- libSDL (usually shipped with distro): http://www.libsdl.org/index.php
-	- SDL_image: http://www.libsdl.org/projects/SDL_image/
-
-For para_slider, the zero memory widget library is neccessary:
-http://www710.univ-lyon1.fr/~exco/ZMW/
-
-Finally, para_krell needs
-
-	- gtk2: http://www.gtk.org/
-	- gkrellm2: http://members.dslextreme.com/users/billw/gkrellm/gkrellm.html
-
 -------
 LICENSE
 -------