[Gnash-commit] /srv/bzr/gnash/trunk r9845: update README with building options, and README_CVS for bzr.

[Russell Nelson]

------------------------------------------------------------
revno: 9845
committer: Russell Nelson <address@hidden>
branch nick: trunk
timestamp: Thu 2008-09-25 12:43:47 -0400
message:
  update README with building options, and README_CVS for bzr.
renamed:
  README_CVS => README_bzr
modified:
  README
  README_bzr

=== modified file 'README'
--- a/README    2008-09-24 19:05:11 +0000
+++ b/README    2008-09-25 16:43:47 +0000
@@ -111,31 +111,43 @@
 ---------------
 
 See the generic installation instructions in the file called "INSTALL".
-(If you are building from a fresh CVS checkout, first see the file
-"README_CVS" for additional instructions.)
-
-Gnash can be configured and built in three main variations.  They
-differ in the graphics and multimedia libraries used to display
-SWF files.  The three variants are configured with the options:
+(If you are building from a fresh bzr checkout, first see the file
+"README_bzr" for additional instructions.)
+
+Gnash has three main options: choice of renderer (graphics library used
+to render the SWF movie), choice(s) of GUI toolkit (gtk, kde, etc), and choice
+of multimedia backend (audio and video decoder).
+
+The choices of renderer (pick one only):
 
    --enable-renderer=opengl
    --enable-renderer=cairo
 or --enable-renderer=agg (default)
 
-Only one can be specified.  In addition, Gnash can use different multimedia
-back-ends for sound and/or video:
+Gnash can use different multimedia back-ends for sound and/or video:
 
    --enable-media=GST                  Gstreamer (default)
 or --enable-media=ffmpeg               Ffmpeg/SDL
 
-The "media" setting is independent of the "renderer" setting.
-
-You will need the following development packages installed to
-build the player with GTK support: glib, atk, pango, cairo, gtk2,
-gtkglext.
-
-You can build the player without GTK support, and these are the
-dependent packages: OpenGL(libMesa), SDL.
+In some countries, the codecs needed to display audio and video are patented.
+The ffmpeg library implements these codecs.  If you link them directly into
+Gnash, you will create an executable which contains patented software and
+requires a license for redistribution in those countries.  If, instead,
+you build using gstreamer, the user installs the codecs of their choice.
+
+Gnash supports multiple graphics toolkits, and will build multiple
+executables:
+
+   --enable-gui=gtk
+   --enable-gui=kde
+or --enable-gui=gtk,kde (default)
+
+Other guis: dump, fb, fltk, kde, gtk, sdl, qtopia, hildon, alp, riscos, aqua.
+Some guis are very specialized (dump writes out raw frames to a disk file).
+Other guis are not very well supported and may not even compile (aqua).
+
+Different options will cause gnash to require different libraries.  The
+configure script does a good job of telling you how to get these libraries.
 
 The GTK support is more developed and featureful, while the SDL
 support has fewer dependencies on other packages. The AGG backend
@@ -151,10 +163,10 @@
 languages. Boost is also required, as Gnash uses it for portable
 mutexes and threading.
 
-Gstreamer version 0.10 is required because earlier versions wouldn't
-let you insert clips into an existing sound stream, as Gnash needs to
-do. If you use Gstreamer, you still need the ffmeg decoders, and the
-ffmpeg plugin for Gstreamer.
+If you select gstreamer as the media backend, gnash requires version 0.10
+because earlier versions wouldn't let you insert clips into an existing
+sound stream, as Gnash needs to do. If you use Gstreamer, you still need
+the ffmeg decoders, and the ffmpeg plugin for Gstreamer.
 
 You no longer need the Mozilla or Firefox development packages to
 build Gnash. All the required files are now included in Gnash, so the
@@ -162,7 +174,7 @@
 
 To build Klash, the Konqueror plugin, you need to have the KDE
 development packages installed. This now installs a KDE executable
-called "klash" that is used by this plugin.
+called "kde-gnash" that is used by this plugin.
 
 The Gnash Community:
 --------------------
@@ -181,7 +193,7 @@
       http://mail.gnu.org/mailman/listinfo/gnash. Volume is typically
       low.
     * address@hidden is where summaries of changes commited to
-      the CVS repository are automatically posted. If you wish to see
+      the bzr repository are automatically posted. If you wish to see
       these changes as they happen,
       http://mail.gnu.org/mailman/listinfo/gnash-commit Volume is
       sporadic, but typically low.

=== renamed file 'README_CVS' => 'README_bzr'
--- a/README_CVS        2008-03-05 03:55:48 +0000
+++ b/README_bzr        2008-09-25 16:43:47 +0000
@@ -1,26 +1,26 @@
 
-               Building Gnash from its CVS repository
+               Building Gnash from its bzr repository
 
-The source code of Gnash is checked into a CVS repository.  (See the main
+The source code of Gnash is checked into a bzr repository.  (See the main
 web page for Gnash for the current details on where that repository is.)
 The instructions for building Gnash in README and INSTALL assume that
 you are starting from a released "tarball" (e.g. gnash-VERSION.tar.gz).
 The tarball contains some files that are not in the original source code
-in CVS.  They are generated using tools that not everyone is expected
+in bzr.  They are generated using tools that not everyone is expected
 to have.  This simplifies the process of building Gnash releases, for
 ordinary people.
 
 People who are actively working on maintaining Gnash need to have these
 extra tools.  They are used to build configuration files, international
 message translation catalogs, and such.  After you check out the source
-code of Gnash from CVS, you'll have to run a single script that rebuilds
+code of Gnash from bzr, you'll have to run a single script that rebuilds
 all these files.  This script is called "./autogen.sh", and it lives
 in the top-level directory of gnash.  You run it without any arguments.
 When it finishes, you can run "./configure", with or without arguments,
 as instructed in the README and INSTALL files.
 
 A variety of GNU programs are required when checking out the
-CVS tree and building the auto-generated files.  If anything is
+bzr tree and building the auto-generated files.  If anything is
 missing, ./autogen.sh will (probably) tell you, or produce a relatively
 understandable error message.  When in doubt, look at the *first*
 error message.  Here are the programs required:
@@ -30,7 +30,7 @@
 -------         -------  -----------    ------------    ---------      
----------
 automake       1.9.6   automake1.9     automake1.9     automake
 autoconf       2.59                    autoconf        autoconf
-cvs            1.11.22                 cvs             cvs
+bzr            1.3                     bzr             bzr
 gettext                0.14.6                  gettext         gettext
 libtool                1.5.22                  libtool         libtool
                1.5.22                  libltdl3-dev    libtool
@@ -49,7 +49,7 @@
 in your operating system (if any).
 
 If you are unable to run ./autogen.sh successfully on your system, consider
-building Gnash from a tarball release.  Or, move the CVS tree to a system
+building Gnash from a tarball release.  Or, move the bzr tree to a system
 on which you can run ./autogen.sh successfully, then move it back to the
 system you are trying to build on.