X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=README;h=72628edaf203f117ca72696c2f1ff4ea9d106548;hb=refs%2Fheads%2FJalview-JS%2Fgradle-minimal;hp=eaf226bfded93f7bdbd8f73a273d339a1e63ed40;hpb=1b98fb9e1fd8dd2d594750ce3cba4e4f1619ed35;p=jalview.git diff --git a/README b/README old mode 100755 new mode 100644 index eaf226b..72628ed --- a/README +++ b/README @@ -1,42 +1,22 @@ -Jalview Readme --------------- +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"). -The source is available as a tar file and comes complete with the GNU General Public License. +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). -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. +gradle tasks of interest: -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. -You may also be able to use Borland JBuilder to build Jalview. A JBuilder project file -(JalviewX.jpx, JalviewApplet.jpx) for both application and applet is provided, -but the library dependencies are almost certainly out of date. See the build.xml -for current dependencies. -For more help, read the file doc/building.html +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 -To run application: +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. -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. If building from source: - -java -Djava.ext.dirs=JALVIEW_BUILD/dist -cp JALVIEW_BUILD/dist/jalview.jar jalview.bin.Jalview - - -################## - - -If you use a proxy server add - --Dhttp.proxyServer=YOUR.SERVER -Dhttp.proxyPort=YOURPORT - -If the proxy server requires authentication, add - --Dhttp.proxyUser=USERNAME -Dhttp.proxyPassword=PASSWORD