Return true or false if file saved
[jalview.git] / doc / building.html
1 <html>
2 <head>
3 <title>Building Jalview from Source</title>
4 </head>
5 <body>
6 <h1>Building Jalview from Source</h1>
7 <P>
8 <p>
9 You will need the following (hopefully):<br>
10 <ul>
11 <li>Java development kit (we used JDK1.4SE but JDK1.5 will work too,
12 and maybe even jikes).
13 <li>Ant (we think 1.5.4 is quite sufficient to use the simple build
14 file supplied).
15 </ul>
16 With any luck, after setting your paths and JAVA_HOME correctly, you
17 just need to change to the Jalview directory and run ant (this works
18 from JBuilder and eclipse too).
19 <pre>
20    ant
21 </pre>
22
23 </p>
24 <p><strong>Building a webstart version of jalview</strong></p>
25 Jalview depends on several libraries contained in the libs directory
26 of the distribution.  In order to access them, they must all be signed
27 jars - using the same jarsigner key as jalview itself. There is a
28 build target in ant to make the signed jar files in a directory called
29 dist. But first you need to make your own key:
30 <p><strong>Making your own key</strong></p>
31
32 <p>The ant 'makefulldist' target assumes that a keystore exists in a
33 directory 'keys'. To make a key accessible using the default settings
34 in the build.xml file then make the keys directory and add the
35 jarsigner key with the following :
36 </p>
37 <pre>
38 mkdir keys
39 keytool -genkey -keystore keys/.keystore -keypass alignmentisfun
40 -storepass alignmentisfun -alias jalview
41  (you will have to answer some personal questions here)
42 ant makejars
43  (should eventually generate a Jalview.jnlp file
44   in ./dist along with a set of signed jars using the jalview
45   key)
46 </pre>
47
48 <p>
49
50 <p>
51 <address>
52 <a href="mailto:help@jalview.org">Jalview development team</a>
53 </address>
54 </body>
55 </html>