[Gnash-commit] gnash README

[Rob Savoye]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         
Changes by:     Rob Savoye <address@hidden>     06/04/06 15:57:35

Modified files:
        .              : README 

Log message:
        Updated based on John's FIXMEs.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/README.diff?tr1=1.5&tr2=1.6&r1=text&r2=text

Patches:
Index: gnash/README
diff -u gnash/README:1.5 gnash/README:1.6
--- gnash/README:1.5    Tue Apr  4 23:26:34 2006
+++ gnash/README        Thu Apr  6 15:57:35 2006
@@ -5,7 +5,7 @@
 plugin, or as a library used by other programs.  It is not yet complete;
 it does not correctly handle every .swf file.
 
-This is the README file for Gnash-0.8, released in April 2006.
+This is the README file for Gnash-0.7, released in April 2006.
 
 Gnash is originally based on the code of GameSWF, by Thatcher Ulrich.
 GameSWF was the most advanced among free flash movie players; it
@@ -50,26 +50,24 @@
 new_method, md length, md substring, md chr, delete, get target 
 
 There is currently no FLV video, only minimal AMF data support,
-and no loading of external jpegs.
-
+and no loading of external jpegs. Sound is currently non-functional.
 
 Plugin:        
 -------
 
 The plugin correctly installs itself into Mozilla, Firefox, or Konqueror.
-It can play some Flash files in cooperation with the browser.  Some web
-pages have Internet Explorer-specific Javascript that fails in Firefox, 
-which prevents the plugin from being loaded.
-
-FIXME:  
-The plugin currently works by creating a new GTK window from within
-the browser. When using SDL instead of GTK, the plugin output appears
-in the correct browser window. Although gtk_plug() is also supposed
-to use the same browser window, I currently get a blank window,
-although the movie plays fine.
-
-FIXME:  What should user do with GTK vs. SDL?  Should they pick one version or
-the other?  It's all gibberish to most users.
+It can play some Flash files in cooperation with the browser. It
+should work with any browser that supports Mozilla's NSPR API and
+plugin SDK. 
+
+Some web pages have Internet Explorer-specific Javascript that fail
+in Firefox, which prevents the plugin from being loaded. In these cases
+I "view source" and then use wget to grab the movie for testing.
+
+By default, the configure script looks for the GtkGl extension, and if
+that can't be found, it defaults to using SDL. The plugin works by
+using the standalone player, so which ever graphics library Gnash
+uses, it's the same as the standalone player.
 
 The GTK version has full event handling, and supports a right-click
 mouse menu to control the movie. The SDL version has no event handling
@@ -78,10 +76,12 @@
 configure.
 
 All Flash movies are downloaded in full to /tmp, and then played from there.
-Gnash is not yet able to play a Flash file "as it arrives" over the network.
+Gnash is not yet able to play a Flash file "as it arrives" over the
+network. Adding the ability to handle input streams is on the TODO list.
 
 Configure with --with-plugindir= to set the directory that "make
-install" will install the plugin in. 
+install" will install the plugin in. By default it will be installed
+in the users .mozilla/plugins or .firefox/plugins directory.
 
 
 Building Gnash:
@@ -89,22 +89,25 @@
 
 See the generic installation instructions in the file called "INSTALL".
 
-FIXME:  Why would you want to build with GTK or without?  
-
 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.
 
+The GTK support is more developed and featureful, while the SDL
+support has less dependancies on other packages.
+
 Other required packages are libxml2, libpng, libjpeg.  The use of
 libxml2 can be dropped if configured with --disable-xml.
 
-FIXME: Not true.
-For sound support, currently SDL_Mixer is supported. SDL_Mixer will be
-going away soon to be replace by the new Gstreamer support. Gstreamer
-version 0.10 is required for this when available. At this time the
-sound support is minimal until the new Gstreamer support is done.
+At this time the sound support is non-functional until the new Gstreamer
+support is done. For sound support, currently SDL_Mixer is
+supported. SDL_Mixer will be going away soon to be replace by the new
+Gstreamer support. Gstreamer version 0.10 will required for this when
+available. As the sound support doesn't work yet, Gnash wll build just
+fine without either SDL_mixer or Gstreamer installed. These packages
+are referenced by Gnash for development purposes.
 
 You no longer need the Mozilla or Firefox development packages to
 build Gnash. All the required files are now included in Gnash so the
@@ -142,11 +145,14 @@
 submit patches at https://savannah.gnu.org/patch/?group=gnash.
 
 Please remember that development of Gnash is a volunteer effort.
-You can contribute to its development. 
+You can contribute to its development. The Gnash project would like to
+find volunteers to focus on win32 and Darwin support, as well as help
+us fill in missing functionality. Offers of help can be sent to
+<address@hidden>.
 
-FIXME:  Where?
 For information about
-contributing to the GNU Project, please read How to help GNU.
+contributing to the GNU Project, please read How to help GNU at
+<http://www.gnu.org/help/help.html>.
 
 If you think you have found a bug in Gnash, then
 you should file as complete a report as possible at