documentation and targets for building a working applet examples
[jalview.git] / doc / index.html
index ab12d5e..fcc01fe 100644 (file)
@@ -1,4 +1,21 @@
 <!DOCTYPE html SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
+<!--\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE.  See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
+-->\r
 <html xmlns="http://www.w3.org/1999/xhtml">\r
 <head>\r
 Jalview Source Documentation\r
@@ -15,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
@@ -120,13 +138,16 @@ 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
+<li>.project - eclipse .project definition</li>\r
 </ul>\r
 \r
 </body>\r
-</html>
\ No newline at end of file
+</html>\r