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 ##
  20
  21 Jalview-JS
  22
  23 To enable transpilation of Jalview's code:
  24
  25 1. Locate the 'dropins' directory in your eclipse installation and copy swingjs/net.sf.j2s.core.jar to it.
  26   - typically it is at the top of the Eclipse installation, or on OSX under Eclipse.app/Contents/Eclipse
  27
  28 2. Restart Eclipse
  29
  30 3. If all is well you should see the 'Java2Script' builder is listed as the primary builder for the Jalview project.
  31   if not, this is because your properties file needs to have the standard java builder replaced with the following:
  32   <name>net.sf.j2s.core.java2scriptbuilder</name>
  33
  34 - otherwise Javascript files will now be generated in the site/swingjs/j2s directory whenever a build occurs
  35
  36 4. Execute the 'unzip-to-site' task (if it isn't automatically run) to update the site directory with the latest versions of SwingJS, varna-js, JSmol and other dependencies required by Jalview.
  37
  38
  39
  40
  41
  42 ##
  43
  44 For more help, read the file doc/building.html
  45
  46
  47 ##################
  48
  49 To run application...
  50 [ NOTE: when using the -classpath option with the '*' wildcard, the argument must be quoted to avoid shell expansion of the wildcard,
  51   ALSO, the wildcard MUST be as DIR/* and not DIR/*.jar etc or it will not be interpreted correctly ]
  52
  53 on Windows use:
  54   java -classpath "JALVIEW_HOME/lib/*;JALVIEW_HOME/jalview.jar" jalview.bin.Jalview
  55 and on MacOS or Linux:
  56   java -classpath "JALVIEW_HOME/lib/*:JALVIEW_HOME/jalview.jar" jalview.bin.Jalview
  57
  58 Replace JALVIEW_HOME with the full path to Jalview Installation Directory. If building from source:
  59
  60   java -classpath "JALVIEW_BUILD/dist/*" jalview.bin.Jalview
  61
  62
  63 ##################
  64
  65
  66 If you use a proxy server add
  67
  68 -Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT
  69
  70 If the proxy server requires authentication, add
  71
  72 -Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD