JAL-3978 clean up unnecessary local variables for JALVIEW_VERSION_UNDERSCORES

[jalview.git] / README_GRADLE_JALVIEWJS-2019-10-22.md

diff --git a/README_GRADLE_JALVIEWJS-2019-10-22.md b/README_GRADLE_JALVIEWJS-2019-10-22.md
index 34e682b..9aaf9d0 100644 (file)
--- a/README_GRADLE_JALVIEWJS-2019-10-22.md
+++ b/README_GRADLE_JALVIEWJS-2019-10-22.md
@@ -42,7 +42,7 @@ gradle jalviewjsSiteTar  # will produce build/distribution/site.tar.gz
 
 gradle jalviewjsTranspile  # should run a new eclipse compile+transpile
 
-gradle jalviewjsServerStart  # will run a localhost http server to allow you to test the site in a browser.  Just use the URL given in the output.  To stop the server you have to do  gradle --stop  or you can just leave it running until the gradle daemon dies.
+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.  To stop the server you have to do  gradle --stop  or you can just leave it running until the gradle daemon dies.
 ```
 
 If it's working okay, you just need to to
@@ -55,6 +55,8 @@ and go to the localhost URL in the output of the jalviewjsServer task in your we
 
 # IN ECLIPSE
 
+## Setting up
+
 If you are developing in Eclipse as IDE (which is the natural way to use Eclipse!) and have the plugin installed, then you will obviously not need to run the transpile as a gradle task -- it will be performed automatically.
 
 Some things to remember:
@@ -67,4 +69,23 @@ to create clean jalview `.classpath, .project, .settings/org.eclipse.jdt.core.pr
 You should only need to do this once.
 Be aware that manual changes to these files will likely be overwritten during some gradle tasks.
 
+If your Eclipse IDE doesn't already have the `net.sf.j2s.core.jar` plugin, you can run on CLI
+```
+gradle jalviewjsEclipseCopyDropins -Pjalviewjs_eclipse_root=/Applications
+```
+(replacing `/Applications` with the folder where your IDE Eclipse is installed).
+You should also only need to do this once but you will have to restart Eclipse if it was already running.
+
+## Building site
+
+The important gradle tasks needed to build and test the site have been adapted/duplicated into the _jalview in eclipse_ group of tasks which you can find in the _Gradle Tasks_ window/tab.
+
+To build the site, your Eclipse should be creating the transpilation continuously into `build/jalviewjs/tmp/site`.  If there are no transpiled files then you should Refresh, Gradle->Refresh Gradle Project, and if nothing has appeared you can Project->Clean which should trigger a rebuild.
+
+You can clean the transpiled code with the gradle task `cleanJalviewjsIDESite`.
+
+To then create the site from the transpiled code and supporting libraries, run the gradle task `jalviewjsIDEBuildSite` which will create a working (hopefully) site in `build/jalviewjs/site`
+
+You can test the build right here in Eclipse, or in a browser of your choice, by running the `jalviewjsIDEServer` task (which is really just the `jalviewjsServer` task).  That will start a localhost server and create an access HTML file, `jalviewjsTest.html`.
 
+You can open that in the Eclipse Internal Web Browser (you might need to Refresh the project to see it the first time you run the server task) by right clicking and Open With...->Web Browser, or you can open the file in your own web browser such as Firefox.