chiark / gitweb /
README, debian/control: Deprecate `sox' support.
[disorder] / README
diff --git a/README b/README
index 9df61faf5024f609f856b9b570890954f33e2534..92a3774cc539808c141853c29f736fb89e892c70 100644 (file)
--- a/README
+++ b/README
@@ -31,10 +31,10 @@ Build dependencies:
   libpcre          7.6         need UTF-8 support
   libmad           0.15.1b
   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
+  libsamplerate    0.1.4       currently optional but strongly recommended
+  GStreamer        0.10        currently optional
   GNU C            4.2.1       }
   GNU Make         3.81        } Non-GNU versions will NOT work
   GNU Sed          4.1.5       }
@@ -45,12 +45,21 @@ Build dependencies:
 "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
@@ -135,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
@@ -265,9 +274,9 @@ 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-2016 Mark Wooding
 Portions extracted from MPG321, http://mpg321.sourceforge.net/
   Copyright (C) 2001 Joe Drew
   Copyright (C) 2000-2001 Robert Leslie