Finish off Mac support in scripts/setup.

[disorder] / README

diff --git a/README b/README
index 1c5edde5cd860d57e1553880569f3d31c48143a1..3c01bddcaede4aa78f8f5414b889b6723a76e53f 100644 (file)
--- a/README
+++ b/README
@@ -41,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
@@ -65,19 +51,33 @@ 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
-============
+Installation (supported platforms)
+==================================
+
+If you are upgrading from an earlier version, see README.upgrades.
+
+For Debian and Ubuntu, you are best of using .deb files, either download from
+www.greenend.org.uk or built locally with 'fakeroot debian/rules binary'.  They
+will do the majority of the setup for you, using a debconf interface to collect
+details about your system.
+
+For FreeBSD, see README.freebsd (in conjunction with the notes below) and use
+scripts/setup.
+
+For Mac OS X, see README.mac (in conjunction with the notes below) and use
+scripts/setup.
+
+
+Installation (generic)
+======================
 
    "This place'd be a paradise tomorrow, if every department had a supervisor
    with a machine-gun"
 
 IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
 
-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:
 
      ./configure --sysconfdir=/etc --localstatedir=/var
@@ -204,6 +204,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:
 
@@ -227,7 +229,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