X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=README;h=19b0c2d17084f40d5d7ac91b2f84e42c402518b6;hb=6f0b432ac19ed1d0d5e01a834586dc81b8a6a72d;hp=10f032b165c265318f2f08382caa5cdce4e22fa2;hpb=df05b75cc541ddf6a0a6fa62e50bbff53df03e30;p=jalview.git diff --git a/README b/README index 10f032b..19b0c2d 100755 --- a/README +++ b/README @@ -4,7 +4,7 @@ Jalview Readme The source is available as a tar file and comes complete with the GNU General Public License. -To build the application you will need a J2SDK 1.6+. +To build the application you will need a J2SDK 1.7+. An Ant build file (build.xml) is provided, you will need to install Apache Ant first. Run ant to view usage which will display a list of useful build targets. @@ -16,6 +16,31 @@ You may also be able to use Borland JBuilder to build Jalview. A JBuilder projec but the library dependencies are almost certainly out of date. See the build.xml for current dependencies. +## + +Jalview-JS + +To enable transpilation of Jalview's code: + +1. Locate the 'dropins' directory in your eclipse installation and copy swingjs/net.sf.j2s.core.jar to it. + - typically it is at the top of the Eclipse installation, or on OSX under Eclipse.app/Contents/Eclipse + +2. Restart Eclipse + +3. If all is well you should see the 'Java2Script' builder is listed as the primary builder for the Jalview project. + if not, this is because your properties file needs to have the standard java builder replaced with the following: + net.sf.j2s.core.java2scriptbuilder + +- otherwise Javascript files will now be generated in the site/swingjs/j2s directory whenever a build occurs + +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. + + + + + +## + For more help, read the file doc/building.html @@ -25,7 +50,10 @@ To run application: java -Djava.ext.dirs=JALVIEW_HOME/lib -cp JALVIEW_HOME/jalview.jar jalview.bin.Jalview -Replace JALVIEW_HOME with the full path to Jalview Installation Directory. +Replace JALVIEW_HOME with the full path to Jalview Installation Directory. If building from source: + +java -Djava.ext.dirs=JALVIEW_BUILD/dist -cp JALVIEW_BUILD/dist/jalview.jar jalview.bin.Jalview + ##################