documentation and targets for building a working applet examples

[jalview.git] / doc / building.html

diff --git a/doc/building.html b/doc/building.html
index 9c09324..5202400 100755 (executable)
--- a/doc/building.html
+++ b/doc/building.html
@@ -62,7 +62,21 @@ ant makedist
   key)
 </pre>
 
-<p>
+       <p>
+               <strong>Building the JalviewLite applet<br>
+               </strong> The JalviewLite applet is compiled using a subset of the packages in
+               the src directory (specifically: MCView, and jalview.{datamodel,
+               analysis, appletgui, utils, schemes, api, structure}, and
+               com.stevesoft.*). Once compiled, these class files are obfuscated to
+               make the code run efficiently. To compile the applet Jar, use the
+               makeApplet task - optionally passing in a 'donotobfuscate' property to
+               the ant build (e.g. -Ddonotobfuscate=true) to disable obfuscation. </p><p>
+               The ant target 'pubapplet' can be used to compile install the
+               jalviewApplet.jar and any dependent jars (under appletlib) into a copy
+               of the examples directory created under the <em>outputDir</em> build
+               property (which defaults to the 'dist' directory).
+       </p>
+       <p>
 <h1>using IDEs to build Jalview</h1>
        <p>The Jalview source distribution includes project definitions for
                Eclipse, Netbeans and some rather ancient Borland JBuilder .jpx