doc/building.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
   4  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 -->
  19 <head>
  20 <title>Building Jalview from Source</title>
  21 </head>
  22 <body>
  23 <h1>Building Jalview from Source</h1>
  24 <P>
  25 <p>
  26 You will need the following (hopefully):<br>
  27 <ul>
  28 <li>Java development kit (we used JDK1.5SE but JDK1.6 will work too,
  29 and maybe even jikes).
  30 <li>Ant (we think 1.5.4 is quite sufficient to use the simple build
  31 file supplied).
  32 </ul>
  33 With any luck, after setting your paths and JAVA_HOME correctly, you
  34 just need to change to the Jalview directory and run ant (this works
  35 from JBuilder and eclipse too).
  36 <pre>
  37    ant
  38 </pre>
  39
  40 </p>
  41 <p><strong>Building a webstart version of jalview</strong></p>
  42 Jalview depends on several libraries contained in the libs directory
  43 of the distribution.  In order to access them, they must all be signed
  44 jars - using the same jarsigner key as jalview itself. There is a
  45 build target in ant to make the signed jar files in a directory called
  46 dist. But first you need to make your own key:
  47 <p><strong>Making your own key</strong></p>
  48
  49 <p>The ant 'makefulldist' target assumes that a keystore exists in a
  50 directory 'keys'. To make a key accessible using the default settings
  51 in the build.xml file then make the keys directory and add the
  52 jarsigner key with the following :
  53 </p>
  54 <pre>
  55 mkdir keys
  56 keytool -genkey -keystore keys/.keystore -keypass alignmentisfun
  57 -storepass alignmentisfun -alias jalview
  58  (you will have to answer some personal questions here)
  59 ant makedist
  60  (should eventually generate a Jalview.jnlp file
  61   in ./dist along with a set of signed jars using the jalview
  62   key)
  63 </pre>
  64
  65 <p>
  66
  67 <p>
  68 <address>
  69 <a href="mailto:help@jalview.org">Jalview development team</a>
  70 </address>
  71 </body>
  72 </html>