X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=README;h=19b0c2d17084f40d5d7ac91b2f84e42c402518b6;hb=refs%2Fheads%2Ftask%2FJAL-3068lineartDialog;hp=eaf226bfded93f7bdbd8f73a273d339a1e63ed40;hpb=14307f5cfcbc90c419c892434613a500ca550ecc;p=jalview.git

diff --git a/README b/README
index eaf226b..19b0c2d 100755
--- a/README
+++ b/README
@@ -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:
+  <name>net.sf.j2s.core.java2scriptbuilder</name>
+
+- 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