chiark / gitweb /
README, debian/control: Deprecate `sox' support.
[disorder] / README
diff --git a/README b/README
index c612846081a5bef3af052f0ce7c7a93c7c135e87..92a3774cc539808c141853c29f736fb89e892c70 100644 (file)
--- a/README
+++ b/README
@@ -33,7 +33,8 @@ Build dependencies:
   libgcrypt        1.4.1
   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       }
@@ -44,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