chiark / gitweb /
New examples/disorder.rc is an /etc/rc.d script for FreeBSD. Finish
[disorder] / README
diff --git a/README b/README
index 9d80eb4..f0f67ea 100644 (file)
--- a/README
+++ b/README
@@ -8,12 +8,13 @@ DisOrder is a multi-user software jukebox.
    * 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.
+     word or tag 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 and README.upgrades for
+upgrade instructions.
 
 The server supports Linux and can be made to work on a Mac (see README.mac).
 The clients work on both Linux and the Mac.  It could probably be ported to
@@ -40,23 +41,9 @@ Build dependencies:
 "Tested" means I've built against that version; earlier or later versions will
 often work too.
 
-Runtime dependencies:
- * Web server:
-   + Apache 1.3.x works for me, but anything that supports CGI and
-     authentication should be suitable.
- * Separate player programs are no longer required (but may still be used)
-
-Development dependencies (only developers will need these):
-  Automake         1.10                AM_PATH_PYTHON not good enough in 1.7
-  Autoconf         2.61
-  Libtool          1.5.22              1.4 not good enough
-  Bazaar (bzr)
-
-On Debian you might ensure you have the required packages as follows:
-  apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
-                  libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
-                  libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
-                  libflac-dev
+For the web interface to work you will additionally need a web server.  I've
+had both Apache 1.3.x and 2.x working.  Anything that supports CGI should be
+OK.
 
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
@@ -64,6 +51,8 @@ Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
    - announcements of new versions of DisOrder
 
+Developers should read README.developers.
+
 
 Installation
 ============
@@ -71,10 +60,11 @@ Installation
    "This place'd be a paradise tomorrow, if every department had a supervisor
    with a machine-gun"
 
-NOTE: If you are upgrading from an earlier version, see README.upgrades.
+IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
 
-On a Debian system, if you install from .deb files then you should be able to
-skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
+On a Debian or Ubuntu system, if you install from .deb files then you should be
+able to skip steps 1 to 6 and configure it via debconf.  This is strongly
+recommended!
 
 1. Build the software.  Do something like this:
 
@@ -117,11 +107,12 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
       filenames, which you should be sure to get right as recovery from an
       error here can be painful (see BUGS).
    Optionally you may also want to do the following:
-    * add 'player' commands for any file formats not supported natively
+    * add 'player' and 'tracklength' commands for any file formats not
+      supported natively
     * edit the 'scratch' commands to supply scratch sounds (or delete them if
       you don't want any).
-    * add or remove 'stopword' entries as necessary (these words won't take
-      part in track name searches from the web interface).
+    * add extra 'stopword' entries as necessary (these words won't take part in
+      track name searches from the web interface).
 
    See disorder_config(5) for more details.
 
@@ -163,7 +154,7 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
      disorder authorize USERNAME
 
    This will automatically choose a random password and create
-   /etc/disorder/config.USERNAME.
+   ~USERNAME/.disorder/passwd.
 
    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
@@ -201,6 +192,8 @@ You need to configure a number of things to make this work:
 
      smtp_server mail.example.com
 
+   Use 'disorder reconfigure' to make sure the server knows these settings.
+
 2. The web interface depends on a 'guest' user existing.  You can create this
    with the following command:
 
@@ -224,7 +217,7 @@ You need to configure a number of things to make this work:
 4. Install disorder.cgi in an appropriate location.  Remember to make it
    executable.  Example:
 
-     install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
+     install -m 755 server/disorder.cgi /usr/lib/cgi-bin/disorder
 
 5. Try it out.  You should be able to perform read-only operations straight
    away, and after visiting the 'Login' page to authenticate, perform other
@@ -256,7 +249,7 @@ Copyright
   "Nothing but another drug, a licence that you buy and sell"
 
 DisOrder - select and play digital audio files
-Copyright (C) 2003-2007 Richard Kettlewell
+Copyright (C) 2003-2008 Richard Kettlewell
 Portions copyright (C) 2007 Ross Younger
 Portions copyright (C) 2007 Mark Wooding
 Portions extracted from MPG321, http://mpg321.sourceforge.net/