Brought documentation up to date.

[videolink.git] / README

diff --git a/README b/README
index 5b1c255351ade23bb86266c8141659b57b385cb6..45c0189c3cfac96f930a85fa7dd36f7807de0231 100644 (file)
--- a/README
+++ b/README
@@ -15,7 +15,7 @@ WebDVD depends on the following software:
 - dvdauthor
 - expat 1.x
 - Gtkmm 2.0
-- mjpegtools 1.6.x (1.8 makes an incompatible change in usage of ppmtoy4m)
+- ffmpeg or mjpegtools
 - Mozilla 1.7.x (later versions may work but are untested)
 - netpbm
 - Xvfb (from XFree86 or X.org)
@@ -24,8 +24,8 @@ To build a complete DVD image you will also need:
 
 - mkisofs
 
-You will also need a program such as ffmpeg or mencoder for producing
-DVD-suitable MPEG-1 or MPEG-2 video files.
+You will also need a program for producing DVD-suitable MPEG-1 or
+MPEG-2 video files.
 
 Usage
 -----
@@ -44,10 +44,6 @@ sequence ("title" in DVD terminology) or to add chapter marks to a
 video sequence, create and link to a VOB-list file (explained below)
 whose name ends in ".voblist".
 
-You can link to a title and begin playback at the beginning of a
-specific chapter by adding "#" and then the chapter number to the end
-of the URL.
-
 VOB-lists
 
 A VOB-list file is an XML file with the document element <vob-list>
@@ -88,6 +84,13 @@ the directory in which to create the filesystem (which should be
 either nonexistent or empty).  WebDVD will automatically follow links
 to the other pages and to the video files.
 
+By default, WebDVD now calls ffmpeg to generate MPEG-2 streams for
+menus.  If you want it to use mjpegtools as it previously did, you
+must add the option "--encoder mjpegtools".  If you use mjpegtools
+1.6.2 or earlier you must instead use "--encoder mjpegtools-old".
+This is due to an incompatible change in the syntax of the ppmtoy4m
+command between versions 1.6.2 and 1.8.
+
 If this is successful you can then use mkisofs to create a DVD image
 from the output directory.  Alternately you can write this directory
 directly to a writable DVD with growisofs or with mkisofs piped to a
@@ -97,7 +100,7 @@ Example
 -------
 
 A live example set of menus can currently be found at
-<http://womble.decadentplace.org.uk/software/debconf5-dvd/menus/main.html>.
+<http://womble.decadent.org.uk/software/debconf5-dvd/menus/main.html>.
 Note that this has large background images that will take some time to
 load.
 
@@ -154,7 +157,7 @@ provide a better solution in a later version of WebDVD.
 Author and copyright
 --------------------
 
-WebDVD was written by Ben Hutchings <ben@decadentplace.org.uk>.
+WebDVD was written by Ben Hutchings <ben@decadent.org.uk>.
 Copyright 2005-2006 Ben Hutchings.
 
 This software is based in part on the work of the Independent JPEG Group.