documentation and targets for building a working applet examples
[jalview.git] / doc / index.html
index 8c18340..fcc01fe 100644 (file)
@@ -32,11 +32,12 @@ Jalview Source Documentation
        information about each task, and there's lots of comments too.</li>\r
        <li></li>\r
        <li>src - all jalview source packages, including any specially\r
-       adapted code from other GPL programs. See <a href="developing.html">Jalvew\r
+       adapted code from other GPL programs. See <a href="developing.html">Jalview\r
        Development</a> for more info.</li>\r
        <li>lib - All the libraries that Jalview depends on. Every jar\r
        file in this directory should be added to the classpath when building\r
        or running the jalview application.</li>\r
+       <li>appletlib - Any libraries that are specifically required for compiling and/or running the jalviewLite applet (e.g. an applet build of Jmol).\r
        <li>help - the jalview JavaHelp documents<br>\r
        <ul>\r
                <li>help.hs - the main index page. This is generated by the\r
@@ -137,12 +138,11 @@ Jalview Source Documentation
                documentation.</li>\r
        </ul>\r
        </li>\r
-       <li>dist - where the Jars and JNLP file for the java webstart distribution is generated.</li>\r
        <li>installAnywhere - where the installAnywhere build is generated</li>\r
        <li><em>keys</em> - you might not have this - see <a\r
                href="building.html">building</a> for info on how to create it.</li>\r
-</ul>\r
-</li>\r
+<li>dist - where the Jars and JNLP file for the java webstart distribution is generated, and where a copy of the examples directory is created complete with jalviewApplet.jar and the contents of appletlib/*.jar.</li>\r
+<li>examples - a set of example jalview projects and web pages demonstrating the jalviewLite applet. This is essentially mirrors the <a href="http://www.jalview.org/examples/">www.jalview.org/examples</a> directory on Jalview's website.</li>\r
 <li>nbbuild.xml - custom config used by the vanilla netbeans project in nbproject</li>\r
 <li>nbproject - vanilla netbeans project</li>\r
 <li>JalviewApplet.jpx, JalviewX.jpx - old JBuilder project files</li>\r