JAL-3210 improved gradle jalviewjsServerStart

[jalview.git] / README

diff --git a/README b/README
old mode 100755 (executable)
new mode 100644 (file)
index 618a615..72628ed
--- a/README
+++ b/README
@@ -1,33 +1,22 @@
-Jalview Readme\r
---------------\r
-\r
-\r
-The source is available as a tar file and comes complete with the GNU General Public License. \r
-\r
-To build the application you will need a J2SDK 1.4+. \r
-\r
-An Ant build file (build.xml) is provided, you will need to install Apache Ant first. Run ant to build the application, use the target "makeApplet" to make the Applet.\r
-\r
-You can also use Borland JBuilder to build Jalview. A JBuilder project file (JalviewX.jpx, JalviewApplet.jpx) for both application and applet is provided.\r
-\r
-For more help, read the file doc/building.html\r
-\r
-\r
-##################\r
-\r
-To run application:\r
-\r
-java -Djava.ext.dirs=JALVIEW_HOME/lib -cp JALVIEW_HOME/jalview.jar jalview.bin.Jalview\r
-\r
-Replace JALVIEW_HOME with the full path to Jalview Installation Directory.
-\r
-##################\r
-\r
-\r
-If you use a proxy server add \r
-\r
--Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT\r
-\r
-If the proxy server requires authentication, add\r
-\r
--Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD\r
+Download and install a clean eclipse-jee-2019-06
+
+In gradle.properties edit `jalviewjs_eclipse_root` to point to the root dir.
+If you're on a mac, DO NOT include the Eclipse.app folder in the path (use the path up to this point, but not the .app folder).
+You can use a '~' as the first character which will get replaced with System.getProperty("user.home").
+
+Note that the gradle tasks will take care of copying net.sf.j2s.core.jar and the com.seeq.eclipse.importprojects.jar into the dropins and plugins dir (on either unix or mac -- not tested on windows yet).
+
+
+gradle tasks of interest:
+
+
+
+gradle jalviewjs  # (should build the .../site dir)
+
+gradle jalviewjsSiteTar  # will produce build/distribution/site.tar.gz
+
+gradle jalviewjsTranspile  # should run a new eclipse compile+transpile
+
+gradle jalviewjsServer  # will run a localhost http server to allow you to test the site in a browser.  Just use the URL given in the output.
+
+