doc/building.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18  * The Jalview Authors are detailed in the 'AUTHORS' file.
  19 -->
  20 <head>
  21 <title>Building Jalview from Source</title>
  22 </head>
  23 <body>
  24 <h1>Building Jalview from Source</h1>
  25 <P>
  26 <p>
  27 You will need the following (hopefully):<br>
  28 <ul>
  29 <li>Java development kit (JDK1.8 is now the recommended platform for developing with Jalview.</li>
  30 <li>Ant (1.7 or later will be needed for some of the jarsigning tools).</li>
  31 </ul>
  32 With any luck, after setting your paths and JAVA_HOME correctly, you
  33 just need to change to the Jalview directory and run ant (this works
  34 from eclipse too, but NetBeans is a bit trickier).
  35 <pre>
  36    ant
  37 </pre>
  38
  39 </p>
  40 <p><strong>Building a webstart version of jalview</strong></p>
  41 Jalview depends on several libraries contained in the libs directory
  42 of the distribution.  In order to access them, they must all be signed
  43 jars - using the same jarsigner key as jalview itself. There is a
  44 build target in ant to make the signed jar files in a directory called
  45 dist. But first you need to make your own key:
  46 <p><strong>Making your own key</strong></p>
  47
  48   <p>The ant 'makefulldist' target assumes that a keystore exists in
  49     a directory 'keys'. To make a key accessible using the default
  50     settings in the build.xml file then make the keys directory and add
  51     the jarsigner key with the following :</p>
  52   <pre>mkdir keys</pre>
  53   <pre>keytool -genkey -keystore keys/.keystore -keypass alignmentisfun
  54   -storepass alignmentisfun -sigalg SHA1withRSA -keyalg RSA -alias jalview</pre>
  55   <em>(you will have to answer some personal questions here)</em>
  56   <pre>ant makedist -DWebStartLocation="file://.pathtojalviewsource./dist" -Dapplication.codebase="*"</pre>
  57   <p>This should eventually generate a jalview.jnlp file in ./dist
  58     along with a set of signed jars using the jalview key). In order to
  59     test locally via webstart you'll now need to add 'file:/' to your
  60     java webstart security exception list. Then:</p>
  61   <pre>javaws file://.pathtojalviewsource./dist/jalview.jnlp</pre>
  62   <p>Please remember to remove that entry afterwards, since it will leave
  63   your system vulnerable to malicious code.
  64   </p>
  65   <p>
  66                 <strong>Building the JalviewLite applet<br>
  67                 </strong> The JalviewLite applet is compiled using a subset of the packages in
  68                 the src directory (specifically: MCView, and jalview.{datamodel,
  69                 analysis, appletgui, utils, schemes, api, structure}, and
  70                 com.stevesoft.*). Once compiled, these class files are obfuscated to
  71                 make the code run efficiently. To compile the applet Jar, use the
  72                 makeApplet task - optionally passing in a 'donotobfuscate' property to
  73                 the ant build (e.g. -Ddonotobfuscate=true) to disable obfuscation. </p><p>
  74                 The ant target 'pubapplet' can be used to compile install the
  75                 jalviewApplet.jar and any dependent jars (under appletlib) into a copy
  76                 of the examples directory created under the <em>outputDir</em> build
  77                 property (which defaults to the 'dist' directory).
  78         </p>
  79         <p>
  80 <h1>using IDEs to build Jalview</h1>
  81         <p>The Jalview source distribution includes project definitions for
  82                 Eclipse, Netbeans and some rather ancient Borland JBuilder .jpx
  83                 project files. These files should be sufficient to set up basic source
  84                 folders and build paths, but you will need to ensure that all .jar
  85                 files in the lib and appletlib directories are added to the build path
  86                 for your IDE project, and that the 'buildindices' target in Jalview's
  87                 build.xml is executed with the 'outputDir' ant property set to the
  88                 directory where the IDE expects to place compiled classes ('classes'
  89                 directory for eclipse, 'build/classes' for netbeans).</p>
  90         <p>Note: It is generally not recommended that you distribute build
  91                 artefacts that were generated automatically via an IDE's own packaging
  92                 mechanism (e.g. Netbeans' executable Jar and dependent lib directory).
  93                 The hand-crafted ant build.xml is (currently) the only officially
  94                 supported method of building distributable versions of Jalview.</p>
  95 <address>
  96 <a href="mailto:help@jalview.org">Jalview development team</a>
  97 </address>
  98 </body>
  99 </html>