Start on 'settings' window. Currently disabled as it's not very

[disorder] / README

diff --git a/README b/README
index f0f67ea32f9ba1139d4c66684e7f841d06768a94..e955e2d422aaa79d8161e6406b9a97a4e359116e 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.
 
 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
 
 Build dependencies:
   Name             Tested              Notes


@@ -62,18 +65,18 @@ Installation
 
 IMPORTANT: 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 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!
+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:
 
 
 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:
 
    If you only want to build a subset of DisOrder, specify one or more of the
    following options:


@@ -84,6 +87,9 @@ recommended!
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
    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
 2. Install it.  Most of the installation is done via the install target:
 
      make installdirs install


@@ -91,6 +97,9 @@ recommended!
    The CGI interface has to be installed separately; see under 'Web Interface'
    below.
 
    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
 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


@@ -161,6 +170,9 @@ recommended!
    Disobedience from some other host, File->Login allows hostnames, passwords
    etc to be configured.
 
    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:
 
 9. Optionally source completion.bash from /etc/profile or similar, for
    example:
 


@@ -174,8 +186,10 @@ Web Interface
 
    "Thought I was a gonner baby, but I'm bullet proof"
 
 
    "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:
 
 
 You need to configure a number of things to make this work: