chiark / gitweb /
Merge branch 'master' of git.distorted.org.uk:~mdw/publish/public-git/disorder
[disorder] / README
diff --git a/README b/README
index 900cf8257265a5770872a1476ffdb0da628fd0fc..80e8d175421c4a297fd7d8038fdc8e83dd65d111 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.html 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.html for upgrade instructions.
 
 Platform support:
   Linux            Well tested on Debian
@@ -25,32 +25,41 @@ effort.
 
 Build dependencies:
   Name             Tested      Notes
-  libdb            4.3.29      not 4.2/4.6; 4.[457] seem to be ok
-  libgc            6.8
-  libvorbisfile    1.1.2
-  libpcre          6.7         need UTF-8 support
+  libdb            5.3.20      also 5.1; not 4.6; 4.[578] seem to be ok
+  libgc            7.4.2
+  libvorbisfile    1.3.5
+  libpcre          10.22 or 7.6 need UTF-8 support
   libmad           0.15.1b
-  libgcrypt        1.2.3
-  libao            0.8.6       1.0.0 is broken
-  libasound        1.0.13
-  libFLAC          1.1.2
-  libsamplerate    0.1.4       currently optional
-  GNU C            4.1.2       }
-  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)
+  libgcrypt        1.7.6
+  libasound        1.1.3
+  libFLAC          1.3.2
+  libsamplerate    0.1.8       currently optional but strongly recommended
+  GStreamer        1.10.4 or 0.10.36 currently optional
+  GNU C            6.4.0       }
+  GNU Make         4.1         } Non-GNU versions will NOT work
+  GNU Sed          4.4         }
+  Python           2.7.13      (optional, 2.5.2 onwards OK; 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.
 
+If you don't have libsamplerate then DisOrder will try to run sox(1) to do
+sample-rate and channel conversion.  Unfortunately, sox has a tendency to
+change its command-line options incompatibly every few years.  Rather than
+chase this moving target by supporting the new options introduced in 14.2,
+I'm declaring DisOrder's sox support to be deprecated -- though (unlike
+sox's policy) it won't actually go away until the next major version.
+Alternatives include building against libsamplerate, or using GStreamer's
+audio decoding instead of DisOrder's built-in decoders.
+
 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/
+  https://github.com/ewxrjk/disorder
 
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
@@ -67,7 +76,8 @@ 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.
+IMPORTANT: If you are upgrading from an earlier version, see
+README.upgrades.html.
 
 Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
 files.
@@ -134,7 +144,7 @@ platform, please get in touch.
 
    See README.streams for how to set up network play.
 
-   If adding new 'player' commands, see README.raw for details on setting up
+   If adding new 'player' commands, see disorder(3) for details on setting up
    "raw format" players.  Non-raw players are still supported but not in all
    configurations and they cannot support pausing and gapless play.  If you
    want additional formats to be supported natively please point the author at
@@ -264,14 +274,16 @@ Copyright
   "Nothing but another drug, a licence that you buy and sell"
 
 DisOrder - select and play digital audio files
-Copyright (C) 2003-2009 Richard Kettlewell
+Copyright (C) 2003-2013 Richard Kettlewell
 Portions copyright (C) 2007 Ross Younger
-Portions copyright (C) 2007 Mark Wooding
+Portions copyright (C) 2007, 2013, 2015-2017 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>
+Unicode test files Copyright (C) 1991-2017 Unicode Inc.; see
+  libtests/COPYING.unicode-tests for details.
 Binaries may derive extra copyright owners through linkage (binary distributors
 are expected to do their own legwork)