some additional documentation

extensions/transformiix/docs/readme.html

@@ -40,10 +40,9 @@ TransforMiiX with Mozilla. This effort
 is not yet complete and therefor the XSLT processor cannot yet be used 
 within the Mozilla browser. Integration is nearing completion, however.
 </P>
-
+<P>
 <HR SIZE="1">
 <P>
-<!-- Entry -->
 <B>Running <B>Transfor<FONT Color="blue">Mii</FONT>X</B> from the command line</B>
 <P />
 The command line syntax is pretty straight forward:
@@ -83,6 +82,79 @@ a wrapper for "source/xsl/XSLProcessor.cpp" which is the TransforMiiX API.
 Feel free to run the examples in the "source/examples" directory, they are a
 good example of what has been implemented so far in TransforMiiX.
 <P>
+
+<HR SIZE="1">
+<P>
+<B>What is the current status of Transfor<FONT Color="blue">Mii</FONT>X</B>?
+<P />
+You can check the current status by looking three main files:
+<UL>
+<LI><A HREF="changes.txt">changes.txt</A> - lists the changes from different builds
+<LI><A HREF="remaining.txt">remaining.txt</A> - lists what needs to be implemented.
+<LI><A HREF="known-issues.html">known-issues.html</A> - lists known bugs or issues.
+<BR />
+ -- this is a little out of date...sorry.
+</UL>
+<P>
+<HR SIZE="1">
+<P>
+<B>What can I do to help finish the implementation of
+ Transfor<FONT Color="blue">Mii</FONT>X</B>?
+<P />
+There are a number of things that can be done:
+<P>
+<B>Development</B>
+<OL>
+<LI>Check out the source code, build it. 
+<LI>Use it. 
+<LI>Familiarize yourself with the code. 
+<LI>Look at the the "to-do" or "known issues" list and choose something
+that you would like to work on. 
+<LI> If it's a large task, notify us that you are working on a task or issue, or
+would like to contribute to the existing effort of a specific task.
+<BR>
+If it's a simple change you may contact us first to make sure
+you are not duplicating effort, or feel free to just make the changes.
+<LI>If you have CVS commit status, commit your code, 
+otherwise submit your code to be integrated to us.
+<BR>
+<B>
+<FONT SIZE="-1">
+Please do a "cvs update" to make sure you have the latest changes, and that
+your changes work with any code changes that might have occured during
+your development. 
+</FONT>
+</B> 
+</OL>
+
+<B>Bug Reporting</B>
+<OL>
+<LI>Check out the source code, build it.
+<LI>Use it.
+<LI>Submit any bugs to the 
+<A HREF="news://news.mozilla.org/netscape.public.mozilla.layout.xslt">
+mailing list [netscape.public.mozilla.layout.xslt]</A>
+ or directly to us.
+</OL>
+
+<B>Documentation</B>
+<OL>
+<LI>Check out the source code, build it.
+<LI>Use it.
+<LI>Find something that's not documented - pretty easy to do at this point.
+<LI>Document #3.
+<LI>If you have commit status, commit your documentation, otherwise
+submit your documentation directly to us.
+</OL>
+<P>
+
+<B>Miscellaneous (but important)</B> <BR>
+<FONT SIZE="-1">&nbsp;-- I just wouldn't be myself if I didn't add these! -- Keith :-) </FONT>
+<OL>
+<LI>Get me a date with Claudia Schiffer or Kelly Hu.
+<LI>Get me some coffee!
+</OL>
+<P>
 <!-- End Contents -->
 
 <!-- Footer -->