chiark / gitweb /
plugins/tracklength-gstreamer.c: Rewrite to use `GstDiscoverer'.
[disorder] / README
diff --git a/README b/README
index 8cd2c35ff954953429e4b5a4ded972d666c9d057..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
@@ -24,32 +24,42 @@ It could probably be ported to some other UNIX variants without too much
 effort.
 
 Build dependencies:
-  Name             Tested              Notes
-  libdb            4.3.29              not 4.2.x; 4.4+ might work.
-  libgc            6.8
-  libvorbisfile    1.1.2
-  libpcre          6.7                 need UTF-8 support
+  Name             Tested      Notes
+  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
-  libasound        1.0.13
-  libFLAC          1.1.2
-  GNU C            4.1.2               }
-  GNU Make         3.81                } Non-GNU versions will NOT work
-  GNU Sed          4.1.5               }
-  Python           2.4.4               (optional)
-  GTK+             2.8.20              (if you want the GTK+ client)
-  GLIB             2.12.4              (if you want the GTK+ client)
+  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
@@ -66,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.
@@ -133,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
@@ -263,28 +274,31 @@ Copyright
   "Nothing but another drug, a licence that you buy and sell"
 
 DisOrder - select and play digital audio files
-Copyright (C) 2003-2008 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)
 
-This program is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free Software
-Foundation; either version 2 of the License, or (at your option) any later
-version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with
-this program; if not, write to the Free Software Foundation, Inc., 59 Temple
-Place, Suite 330, Boston, MA 02111-1307 USA
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Local Variables:
 mode:text