doc/building.html

   1 #-------------------------------------------------------------------------------
   2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
   3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   4 #
   5 # This file is part of Jalview.
   6 #
   7 # Jalview is free software: you can redistribute it and/or
   8 # modify it under the terms of the GNU General Public License
   9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10 #
  11 # Jalview is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty
  13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14 # PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17 #-------------------------------------------------------------------------------
  18 <html>
  19 <!--
  20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
  21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  22  *
  23  * This file is part of Jalview.
  24  *
  25  * Jalview is free software: you can redistribute it and/or
  26  * modify it under the terms of the GNU General Public License
  27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  28  *
  29  * Jalview is distributed in the hope that it will be useful, but
  30  * WITHOUT ANY WARRANTY; without even the implied warranty
  31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  32  * PURPOSE.  See the GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  35 -->
  36 <head>
  37 <title>Building Jalview from Source</title>
  38 </head>
  39 <body>
  40 <h1>Building Jalview from Source</h1>
  41 <P>
  42 <p>
  43 You will need the following (hopefully):<br>
  44 <ul>
  45 <li>Java development kit (we used JDK1.4SE but JDK1.5 will work too,
  46 and maybe even jikes).
  47 <li>Ant (we think 1.5.4 is quite sufficient to use the simple build
  48 file supplied).
  49 </ul>
  50 With any luck, after setting your paths and JAVA_HOME correctly, you
  51 just need to change to the Jalview directory and run ant (this works
  52 from JBuilder and eclipse too).
  53 <pre>
  54    ant
  55 </pre>
  56
  57 </p>
  58 <p><strong>Building a webstart version of jalview</strong></p>
  59 Jalview depends on several libraries contained in the libs directory
  60 of the distribution.  In order to access them, they must all be signed
  61 jars - using the same jarsigner key as jalview itself. There is a
  62 build target in ant to make the signed jar files in a directory called
  63 dist. But first you need to make your own key:
  64 <p><strong>Making your own key</strong></p>
  65
  66 <p>The ant 'makefulldist' target assumes that a keystore exists in a
  67 directory 'keys'. To make a key accessible using the default settings
  68 in the build.xml file then make the keys directory and add the
  69 jarsigner key with the following :
  70 </p>
  71 <pre>
  72 mkdir keys
  73 keytool -genkey -keystore keys/.keystore -keypass alignmentisfun
  74 -storepass alignmentisfun -alias jalview
  75  (you will have to answer some personal questions here)
  76 ant makedist
  77  (should eventually generate a Jalview.jnlp file
  78   in ./dist along with a set of signed jars using the jalview
  79   key)
  80 </pre>
  81
  82 <p>
  83
  84 <p>
  85 <address>
  86 <a href="mailto:help@jalview.org">Jalview development team</a>
  87 </address>
  88 </body>
  89 </html>