[cvs-annodex] commit (/annodex): AnnodexFirefoxExtension/trunk/README.txt

[conrad]

Update of /annodex (new revision 947)

Modified files:
   AnnodexFirefoxExtension/trunk/README.txt

Log Message:
add some more blurb about what the chrome is etc.
+ very basic info about building the Windows .xpi.


Modified: AnnodexFirefoxExtension/trunk/README.txt
===================================================================
--- AnnodexFirefoxExtension/trunk/README.txt	2005-02-24 15:47:14 UTC (rev 946)
+++ AnnodexFirefoxExtension/trunk/README.txt	2005-02-24 22:09:56 UTC (rev 947)
@@ -16,20 +16,32 @@
 Building AnnodexFirefoxExtension (AFE)
 ======================================
 
-There are two components to AFE: the chrome, which is all
-XUL/HTML/Javascript; and the compiled video plugin, using VLC.
-Each of these components gets their own .xpi package (the chrome is
-platorm-independent, the video plugin is native code).
+There are two components to AFE:
 
+    1. the chrome, which is an XUL application providing the overall
+    video browsing user interface (clip list, transport controls etc.)
+
+    2. the compiled video plugin, currently hardcoded to use VLC
+
+The chrome is platorm-independent, and the video plugin is native code.
+The chrome registers itself with Mozilla as the handler for
+application/x-annodex, and it embeds the video plugin.
+
+Each of these components gets their own .xpi package -- the chrome is
+the same on all platforms, but a different video plugin is required for
+each operating system and CPU architecture.
+
 Installer/MakeFirefoxXPI.sh packages the .xpi for the chrome. It should
 just work without any preparation.
 
-Building AFE for Linux
-----------------------
+In order to package the second .xpi for the video plugin, you first need
+to build some binaries for your platform.
 
-Installer/MakeLinuxVLCPluginXPI.sh packages the .xpi for the video
-plugin. Before you do that, you need to build the plugin:
+Building the video plugin for Linux
+-----------------------------------
 
+To build the video plugin:
+
 cd Linux/VLC-Build
 ./Patch
 ./Build
@@ -42,7 +54,15 @@
 Installer/MakeLinuxVLCPluginXPI.sh will take the files from
 Linux/bin-$ARCH and package them into an .xpi.
 
+Building AFE for Windows
+------------------------
 
+Building AFE uses a similar procedure to Linux. The required plugins must
+be placed in Windows/BuiltPlugin.
+
+Installer/MakeWindowsVLCPluginXPI.sh packages the .xpi for the video
+plugin, using the files from Windows/BuiltPlugin.
+
 Development Overview
 ====================
 


-- 
conrad