utf32_word_split() and utf8_word_split() splits a string into words

[disorder] / README

diff --git a/README b/README
index d59e017805bb7811f6c8705b4b9f0143f9ed9d1a..060c8b830766d377d7bb8e0c318d21a42c8bad9b 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,23 @@
 DisOrder
 ========
 
 DisOrder
 ========
 

-This program is used to play random and chosen tracks from a collection of
-digital audio files (for instance MP3 and OGG files).  If you just set it going
-it plays random tracks from your collection, but you can also ask for specific
-tracks to be played, either via a command line program or a web interface, and
-you can 'scratch' the current track.
+DisOrder is a multi-user software jukebox.
+   * It can play either selected tracks or pick tracks at random.
+   * It supports OGG, MP3, FLAC and WAV files, and can be configured to support
+     anything you can supply a player for (up to a point).
+   * It supports both ALSA and OSS and can also broadcast an RTP stream over a
+     LAN; a player for the latter is included.
+   * Tracks may be selected either via a hierarchical interface or by a fast
+     word search.
+   * It has a web interface (allowing access from graphical web browsers) and a
+     GTK+ interface that runs on Linux and Mac systems.
+   * Playing tracks can be paused or cancelled ("scratched").

 
 See CHANGES for details of recent changes to DisOrder.
 
 
 See CHANGES for details of recent changes to DisOrder.
 

-Currently it only runs on Linux.  It could probably be ported to other UNIX
-variants in some cases without too much effort.  Things you will need:
+The server supports Linux and can be made to on a Mac.  The clients work on
+both Linux and the Mac.  It could probably be ported to some other UNIX
+variants in without too much effort.  Things you will need:

 
 Build dependencies:
   Name             Tested              Notes
 
 Build dependencies:
   Name             Tested              Notes


@@ -25,6 +32,7 @@ Build dependencies:
   libFLAC          1.1.2
   GNU C            4.1.2
   GNU Make         3.81
   libFLAC          1.1.2
   GNU C            4.1.2
   GNU Make         3.81

+  GNU Sed          4.1.5

   Python           2.4.4               (optional)
   GTK+             2.8.20              (if you want the GTK+ client)
   GLIB             2.12.4              (if you want the GTK+ client)
   Python           2.4.4               (optional)
   GTK+             2.8.20              (if you want the GTK+ client)
   GLIB             2.12.4              (if you want the GTK+ client)


@@ -140,33 +148,23 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
    start up correctly there should be an error message.  Correct the problem
    and try again.
 
    start up correctly there should be an error message.  Correct the problem
    and try again.
 

-7. After a minute it should start to play something.  Try scratching it, as any
-   of the users you set up in step 5:
+7. After a minute it should start to play something.  Try scratching it:

 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 
 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 

-8. Add any other users you want to config.private.  Each user's password
-   should be stored in a file in their home directory, ~/.disorder/passwd,
-   which should be readable only by them, and should take the form of a single
-   line:
+8. Add any other users you want.  These easiest way to do this is:

 
 

-     password MYPASSWORD
-
-   (root doesn't need this as the client can read it out of config.private
-   when running as root.)
-
-   Note that the server must be reloaded (e.g. by 'disorder reconfigure')
-   when new users are added.
+     disorder authorize USERNAME

 
 

-   Alternatively the administrator can create /etc/disorder/config.USERNAME
-   containing the same thing as above.  It can either be owned by the user and
-   mode 400, or owned by root and the user's group (if you have per-user
-   groups) and mode 440.
+   This will automatically choose a random password and add new line to
+   /etc/disorder/config.private and create /etc/disorder/config.USERNAME.

 
 

-   You can use 'disorder authorize' to automatically pick passwords and
-   create these files.
+   Those users should now be able to access the server from the same host as it
+   runs on, either via the disorder command or Disobedience.  To run
+   Disobedience from some other host, File->Login allows hostnames, passwords
+   etc to be configured.

 
 9. Optionally source completion.bash from /etc/profile or similar, for
    example:
 
 9. Optionally source completion.bash from /etc/profile or similar, for
    example: