Account choose_list_in_flight correctly.

[disorder] / README

diff --git a/README b/README
index e955e2d422aaa79d8161e6406b9a97a4e359116e..acd06ee5b2ee690269849eaa0194b37259be5a8c 100644 (file)
--- a/README
+++ b/README
@@ -13,8 +13,8 @@ DisOrder is a multi-user software jukebox.
      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 and README.upgrades for
-upgrade instructions.
+See CHANGES.html for details of recent changes to DisOrder and README.upgrades
+for upgrade instructions.
 
 Platform support:
   Linux            Well tested on Debian
@@ -48,6 +48,9 @@ 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.
 
+Bug tracker, etc:
+  http://code.google.com/p/disorder/
+
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
    - discussion of DisOrder (and other software), bug reports, etc
@@ -68,8 +71,9 @@ IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
 Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
 files.
 
-OX X/FreeBSD/other Linux: after installation (step 1) 'sudo bash scripts/setup'
-covers steps 3 to 6.  If it doesn't work on your platform, please get in touch.
+OX X/FreeBSD/other Linux: after installation (step 1 and 2), running
+'sudo bash scripts/setup' will cover steps 3 to 6.  If it doesn't work on your
+platform, please get in touch.
 
 1. Build the software.  Do something like this:
 
@@ -84,6 +88,11 @@ covers steps 3 to 6.  If it doesn't work on your platform, please get in touch.
      --without-gtk          Don't build GTK+ client (Disobedience)
      --without-python       Don't build Python support
 
+   If configure cannot guess where your web server keeps its HTML documents and
+   CGI programs, you may have to tell it, for instance:
+
+     ./configure cgidir=/whatever/cgi-bin httpdir=/whatever/htdocs
+
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
@@ -94,9 +103,6 @@ covers steps 3 to 6.  If it doesn't work on your platform, please get in touch.
 
      make installdirs install
 
-   The CGI interface has to be installed separately; see under 'Web Interface'
-   below.
-
    NB steps 3 to 6 are covered by scripts/setup.  It should work on FreeBSD, OS
    X and Linux and could be adapted to other platforms.
 
@@ -200,9 +206,15 @@ You need to configure a number of things to make this work:
 
      mail_sender webmaster@example.com
 
-   By default the web interface sends mail by connecting to the SMTP port of
-   127.0.0.1.  You can override this with the smtp_server directive, for
-   exampler:
+   By default the web interface sends mail via the system sendmail executable
+   (typically /usr/sbin/sendmail or /usr/lib/sendmail).  You can override this
+   with the sendmail directive, for example:
+
+     sendmail /usr/sbin/my-sendmail
+
+   The executable you choose must support the -bs option.  Alternatively you
+   can tell it to connect to an SMTP server via TCP, with the smtp_server
+   directive.  For example:
 
      smtp_server mail.example.com
 
@@ -217,31 +229,15 @@ You need to configure a number of things to make this work:
 
      disorder setup-guest --no-online-registration
 
-3. Make sure that DisOrder can find its icons and stylesheet.  For example in
-   your web server configuration:
-
-     Alias /disorder/ /usr/local/share/disorder/static/
-
-   Alternatively you could use a symlink from the right location in your
-   document root, provided your web server is configured to follow them.
-
-     cd /var/www
-     ln -s /usr/local/share/disorder/static disorder
-
-4. Install disorder.cgi in an appropriate location.  Remember to make it
-   executable.  Example:
-
-     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
+3. Try it out.  You should be able to perform read-only operations straight
    away, and after visiting the 'Login' page to authenticate, perform other
    operations like adding a track to the queue.
 
-6. If you run into problems, always look at the appropriate error log; the
+4. If you run into problems, always look at the appropriate error log; the
    message you see in your web browser will usually not be sufficient to
    diagnose the problem all by itself.
 
-7. If you have a huge number of top level directories, then you might find
+5. If you have a huge number of top level directories, then you might find
    that the 'Choose' page is unreasonably large.  If so add the following line
    to /etc/disorder/options.user:
      label sidebar.choosewhich choosealpha
@@ -269,6 +265,7 @@ Portions copyright (C) 2007 Mark Wooding
 Portions extracted from MPG321, http://mpg321.sourceforge.net/
   Copyright (C) 2001 Joe Drew
   Copyright (C) 2000-2001 Robert Leslie
+Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
 Binaries may derive extra copyright owners through linkage (binary distributors
 are expected to do their own legwork)