chiark / gitweb /
Missing gcry_md_close.
[disorder] / README
diff --git a/README b/README
index 27657db..b1ddc92 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
@@ -24,22 +24,23 @@ It could probably be ported to some other UNIX variants without too much
 effort.
 
 Build dependencies:
-  Name             Tested              Notes
-  libdb            4.3.29              not 4.2.x; 4.4+ might work.
+  Name             Tested      Notes
+  libdb            4.5.20      not 4.6; 4.[78] seem to be ok
   libgc            6.8
-  libvorbisfile    1.1.2
-  libpcre          6.7                 need UTF-8 support
+  libvorbisfile    1.2.0
+  libpcre          7.6         need UTF-8 support
   libmad           0.15.1b
-  libgcrypt        1.2.3
-  libao            0.8.6
-  libasound        1.0.13
-  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)
+  libgcrypt        1.4.1
+  libao            0.8.8       1.0.0 is broken
+  libasound        1.0.16
+  libFLAC          1.2.1
+  libsamplerate    0.1.4       currently optional
+  GNU C            4.2.1       }
+  GNU Make         3.81        } Non-GNU versions will NOT work
+  GNU Sed          4.1.5       }
+  Python           2.5.2       (optional; 2.4 won't work)
+  GTK+             2.12.12     (for the GTK+ client; 2.10 & older will NOT work)
+  GLIB             2.16.6      (for the GTK+ client)
 
 "Tested" means I've built against that version; earlier or later versions will
 often work too.
@@ -88,6 +89,11 @@ 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 cgiexecdir=/whatever/cgi-bin httpdir=/whatever/htdocs
+
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
@@ -98,9 +104,6 @@ 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.
 
@@ -204,9 +207,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
 
@@ -221,31 +230,19 @@ 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:
+3. Try it out.  The url will be (something like):
 
-     install -m 755 server/disorder.cgi /usr/lib/cgi-bin/disorder
+     http://localhost/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
-   operations like adding a track to the queue.
+   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
@@ -267,28 +264,29 @@ Copyright
   "Nothing but another drug, a licence that you buy and sell"
 
 DisOrder - select and play digital audio files
-Copyright (C) 2003-2008 Richard Kettlewell
+Copyright (C) 2003-2009 Richard Kettlewell
 Portions copyright (C) 2007 Ross Younger
 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.
+Portions Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
 Binaries may derive extra copyright owners through linkage (binary distributors
 are expected to do their own legwork)
 
-This program is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free Software
-Foundation; either version 2 of the License, or (at your option) any later
-version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with
-this program; if not, write to the Free Software Foundation, Inc., 59 Temple
-Place, Suite 330, Boston, MA 02111-1307 USA
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Local Variables:
 mode:text