Merge branch 'merge/JAL-3628+JAL-3608+JAL-3609+JAL-3541+Release_2_11_1_Branch' into...
[jalview.git] / README
1 Jalview Readme
2 --------------
3
4
5 The source is available as a tar file and comes complete with the GNU General Public License. 
6
7 To build the application you will need a J2SDK 1.7+. 
8
9 An Ant build file (build.xml) is provided, you will need to install Apache Ant first. 
10 Run ant to view usage which will display a list of useful build targets.
11
12 Jalview is primarily developed with eclipse, and a .project file is provided to simplify importing the source into your own eclipse workspace. A NetBeans nbbuild.xml file is also provided for developing Jalview with NetBeans - but this is not officially supported.
13
14 You may also be able to use Borland JBuilder to build Jalview. A JBuilder project file 
15 (JalviewX.jpx, JalviewApplet.jpx) for both application and applet is provided, 
16 but the library dependencies are almost certainly out of date. See the build.xml 
17 for current dependencies.
18
19 For more help, read the file doc/building.html
20
21
22 ##################
23
24 To run application...
25 [ NOTE: when using the -classpath option with the '*' wildcard, the argument must be quoted to avoid shell expansion of the wildcard,
26   ALSO, the wildcard MUST be as DIR/* and not DIR/*.jar etc or it will not be interpreted correctly ]
27
28 on Windows use:
29   java -classpath "JALVIEW_HOME/lib/*;JALVIEW_HOME/jalview.jar" jalview.bin.Jalview
30 and on MacOS or Linux:
31   java -classpath "JALVIEW_HOME/lib/*:JALVIEW_HOME/jalview.jar" jalview.bin.Jalview
32
33 Replace JALVIEW_HOME with the full path to Jalview Installation Directory. If building from source:
34
35   java -classpath "JALVIEW_BUILD/dist/*" jalview.bin.Jalview
36
37
38 ##################
39
40
41 If you use a proxy server add 
42
43 -Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT
44
45 If the proxy server requires authentication, add
46
47 -Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD