chiark / gitweb /
Complete README changes for scripts/setup. README.{mac,freebsd} are
authorRichard Kettlewell <rjk@greenend.org.uk>
Sat, 19 Jan 2008 12:37:10 +0000 (12:37 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Sat, 19 Jan 2008 12:37:10 +0000 (12:37 +0000)
now gone.

CHANGES
Makefile.am
README
README.freebsd [deleted file]
README.mac [deleted file]
debian/rules

diff --git a/CHANGES b/CHANGES
index 366f9ee..e3c4d27 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,5 +1,10 @@
 * Changes up to version 2.1
 
+** Platforms And Installation
+
+Mac OS X and FreeBSD are somewhat supported.  There is now a bash script
+in scripts/setup which will automate the setup after 'make install'.
+
 ** Server
 
 Users are now stored in the database rather than a configuration file.
index 83df2ba..87a70c0 100644 (file)
@@ -19,8 +19,7 @@
 #
 
 EXTRA_DIST=TODO CHANGES README.streams BUGS \
-README.upgrades README.client README.mac README.raw README.vhost \
-README.freebsd README.developers
+README.upgrades README.client README.raw README.vhost README.developers
 SUBDIRS=@subdirs@
 
 check-report: before-check check make-coverage-reports
diff --git a/README b/README
index 3c01bdd..e955e2d 100644 (file)
--- a/README
+++ b/README
@@ -16,9 +16,12 @@ DisOrder is a multi-user software jukebox.
 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
-some other UNIX variants without too much effort.  Things you will need:
+Platform support:
+  Linux            Well tested on Debian
+  Mac OS X         Disobedience well tested, server somewhat tested; use fink
+  FreeBSD          Scantily tested; use ports for dependencies
+It could probably be ported to some other UNIX variants without too much
+effort.
 
 Build dependencies:
   Name             Tested              Notes
@@ -53,39 +56,27 @@ Mailing lists:
 
 Developers should read README.developers.
 
-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)
-======================
+Installation
+============
 
    "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.
 
+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.
+
 1. Build the software.  Do something like this:
 
-     ./configure --sysconfdir=/etc --localstatedir=/var
-     make
+     ./configure
+     make                   # on FreeBSD use gmake
 
-   See INSTALL for more details about driving configure.  The precise set of
-   options you pass to configure is up to you, if you like configuration being
-   in /usr/local/etc or wherever then that should work.
+   See INSTALL or ./configure --help for more details about driving configure.
 
    If you only want to build a subset of DisOrder, specify one or more of the
    following options:
@@ -96,6 +87,9 @@ IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
+   To build .debs on Debian/Ubuntu, use:
+     fakeroot debian/rules binary
+
 2. Install it.  Most of the installation is done via the install target:
 
      make installdirs install
@@ -103,6 +97,9 @@ IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
    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.
+
 3. Create a 'jukebox' user and group, with the jukebox group being the default
    group of the jukebox user.  The server will run as this user and group.
    Check that this user can read your music files and write to the audio
@@ -173,6 +170,9 @@ IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
    Disobedience from some other host, File->Login allows hostnames, passwords
    etc to be configured.
 
+   Alternatively, after setting up the web interface (below), it's possible to
+   allow users to register themselves without operator involvement.
+
 9. Optionally source completion.bash from /etc/profile or similar, for
    example:
 
@@ -186,8 +186,10 @@ Web Interface
 
    "Thought I was a gonner baby, but I'm bullet proof"
 
-As above, if you install from a .deb, much of the work will be done
-automatically.
+Debian/Ubuntu: the .deb files will do the setup here automatically.
+
+OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
+here automatically.
 
 You need to configure a number of things to make this work:
 
diff --git a/README.freebsd b/README.freebsd
deleted file mode 100644 (file)
index ac38e77..0000000
+++ /dev/null
@@ -1,20 +0,0 @@
-DisOrder on FreeBSD
-===================
-
-The server builds on FreeBSD, using the ports system to supply many of
-its dependencies.  It is not well tested in this environment.  In
-particular, since my FreeBSD VM lacks sound support, only network play
-has been tested.
-
-You must use gmake to build DisOrder.
-
-After installation you can use scripts/setup to install the server
-(creating a 'jukebox' user, etc).
-
-  ./configure
-  gmake
-  sudo gmake install
-  sudo scripts/setup
-  sudo disorder setup-guest [--no-online-registration]
-
-Please report successes and failures!
diff --git a/README.mac b/README.mac
deleted file mode 100644 (file)
index 478954d..0000000
+++ /dev/null
@@ -1,16 +0,0 @@
-DisOrder on OS X
-================
-
-The server builds on OS X, using Fink to supply many of its
-dependencies.  It is not well tested in this environment.
-
-After installation you can use scripts/setup to install the server
-(creating a 'jukebox' user, etc).
-
-  ./configure
-  make
-  sudo make install
-  sudo scripts/setup
-  sudo disorder setup-guest [--no-online-registration]
-
-Please report successes and failures!
index 551014d..53dc486 100755 (executable)
@@ -105,8 +105,6 @@ pkg-disorder: build
        $(INSTALL_DATA) CHANGES README debian/README.Debian \
                BUGS README.* \
                debian/disorder/usr/share/doc/disorder/.
-       rm -f debian/disorder/usr/share/doc/disorder/README.mac
-       rm -f debian/disorder/usr/share/doc/disorder/README.freebsd
        gzip -9f debian/disorder/usr/share/doc/disorder/CHANGES \
                 debian/disorder/usr/share/doc/disorder/README \
                 debian/disorder/usr/share/doc/disorder/README.* \