doc/building-OLD.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
  27 <p>
  28 You will need the following:<br/>
  29 <ul>
  30   <li> Obtain: git</li>
  31   <li> Build/run: Java Development Kit (JDK). JDK11 is now the recommended platform for developing with Jalview.  You can obtain a pre-compiled JDK11 for many platforms from https://adoptopenjdk.net/</li>
  32   <li> Build: Gradle 5.1 or later.  On linux you can obtain this with your package manager (e.g. <code>sudo yum install gradle</code> or <code>sudo apt install gradle</code> or on macOS with brew with <code>brew install gradle</code></li>
  33 </ul>
  34 With any luck, once you check out the Jalview source from git and set your JAVA_HOME and PATH correctly, you just need to change to the <code>jalview</code> directory and run <code>gradle getdown</code>.
  35 </p>
  36
  37 <h2>Obtaining Jalview</h2>
  38 <p>This is easiest achieved with git:
  39 <pre>git clone http://www.jalview.org/git/jalview.git</pre>
  40 Then you can <code>cd jalview</code> to get into the top level jalview dir.
  41
  42
  43 <p>
  44 <h2>Minimal Jalview build</h2>
  45 <p>To run Jalview, you just need the jalview classes and the .jar libraries that Jalview depends on.</p>
  46
  47
  48 <p>
  49 You will need the following (hopefully):<br>
  50 <ul>
  51 <li>Java development kit (JDK1.8 is now the recommended platform for developing with Jalview.</li>
  52 <li>Ant (1.7 or later will be needed for some of the jarsigning tools).</li>
  53 </ul>
  54 With any luck, after setting your paths and JAVA_HOME correctly, you
  55 just need to change to the Jalview directory and run ant (this works
  56 from eclipse too, but NetBeans is a bit trickier).
  57 <pre>
  58    ant
  59 </pre>
  60
  61 </p>
  62 <p><strong>Building a webstart version of jalview</strong></p>
  63 Jalview depends on several libraries contained in the libs directory
  64 of the distribution.  In order to access them, they must all be signed
  65 jars - using the same jarsigner key as jalview itself. There is a
  66 build target in ant to make the signed jar files in a directory called
  67 dist. But first you need to make your own key:
  68 <p><strong>Making your own key</strong></p>
  69
  70   <p>The ant 'makefulldist' target assumes that a keystore exists in
  71     a directory 'keys'. To make a key accessible using the default
  72     settings in the build.xml file then make the keys directory and add
  73     the jarsigner key with the following :</p>
  74   <pre>mkdir keys</pre>
  75   <pre>keytool -genkey -keystore keys/.keystore -keypass alignmentisfun
  76   -storepass alignmentisfun -sigalg SHA1withRSA -keyalg RSA -alias jalview</pre>
  77   <em>(you will have to answer some personal questions here)</em>
  78   <pre>ant makedist -DWebStartLocation="file://.pathtojalviewsource./dist" -Dapplication.codebase="*"</pre>
  79   <p>This should eventually generate a jalview.jnlp file in ./dist
  80     along with a set of signed jars using the jalview key). In order to
  81     test locally via webstart you'll now need to add 'file:/' to your
  82     java webstart security exception list. Then:</p>
  83   <pre>javaws file://.pathtojalviewsource./dist/jalview.jnlp</pre>
  84   <p>Please remember to remove that entry afterwards, since it will leave
  85   your system vulnerable to malicious code.
  86   </p>
  87   <p>
  88                 <strong>Building the JalviewLite applet<br>
  89                 </strong> The JalviewLite applet is compiled using a subset of the packages in
  90                 the src directory (specifically: MCView, and jalview.{datamodel,
  91                 analysis, appletgui, utils, schemes, api, structure}, and
  92                 com.stevesoft.*). Once compiled, these class files are obfuscated to
  93                 make the code run efficiently. To compile the applet Jar, use the
  94                 makeApplet task - optionally passing in a 'donotobfuscate' property to
  95                 the ant build (e.g. -Ddonotobfuscate=true) to disable obfuscation. </p><p>
  96                 The ant target 'pubapplet' can be used to compile install the
  97                 jalviewApplet.jar and any dependent jars (under appletlib) into a copy
  98                 of the examples directory created under the <em>outputDir</em> build
  99                 property (which defaults to the 'dist' directory).
 100         </p>
 101         <p>
 102 <h1>using IDEs to build Jalview</h1>
 103         <p>The Jalview source distribution includes project definitions for
 104                 Eclipse, Netbeans and some rather ancient Borland JBuilder .jpx
 105                 project files. These files should be sufficient to set up basic source
 106                 folders and build paths, but you will need to ensure that all .jar
 107                 files in the lib and appletlib directories are added to the build path
 108                 for your IDE project, and that the 'buildindices' target in Jalview's
 109                 build.xml is executed with the 'outputDir' ant property set to the
 110                 directory where the IDE expects to place compiled classes ('classes'
 111                 directory for eclipse, 'build/classes' for netbeans).</p>
 112         <p>Note: It is generally not recommended that you distribute build
 113                 artefacts that were generated automatically via an IDE's own packaging
 114                 mechanism (e.g. Netbeans' executable Jar and dependent lib directory).
 115                 The hand-crafted ant build.xml is (currently) the only officially
 116                 supported method of building distributable versions of Jalview.</p>
 117 <address>
 118 <a href="mailto:help@jalview.org">Jalview development team</a>
 119 </address>
 120 </body>
 121 </html>