X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=doc%2Fbuilding.md;h=34d5d67f672a370a4f86b130e607beca872d9c13;hb=69b246bd6330f05271ca15a440c8442b03b7db6c;hp=3122efb0cb19c3fc92808fc90fc19691a422ee80;hpb=dfeb3218d3ffbe36bb289ebfacbe2ed23ba26cc1;p=jalview.git diff --git a/doc/building.md b/doc/building.md index 3122efb..34d5d67 100644 --- a/doc/building.md +++ b/doc/building.md @@ -6,7 +6,7 @@ # download git clone http://source.jalview.org/git/jalview.git # compile -cd jalview +cd ./jalview gradle shadowJar # run java -jar build/libs/jalview-all-*-j11.jar @@ -14,7 +14,7 @@ java -jar build/libs/jalview-all-*-j11.jar # and/or create launcher gradle getdown # use launcher -cd getdown/files +cd ./build/getdown/files/11 java -jar getdown-launcher.jar . jalview ``` @@ -484,7 +484,7 @@ About splashscreen, Installer backgrounds, application name. This is controlled utils/channels ``` In `utils/channels` there are different directories for the different channels. Currently there are directories for -`develop`, `release`, `test-release` and `default`. If a specified `CHANNEL` is not one of `DEVELOP`, `RELEASE` or `TEST-RELEASE` +`default`, `develop`, `release`, `test-release`, `jalviewjs` and `jalviewjs-release`. If a specified `CHANNEL` is not one of `DEVELOP`, `RELEASE`, `TEST-RELEASE`, `JALVIEWJS`, `JALVIEWJS-RELEASE` then it will use the `default` directory. Inside the `utils/channels/` directory are: @@ -495,8 +495,10 @@ Inside the `utils/channels/` directory are: #### JALVIEW_VERSION and the RELEASE file Any Jalview build will include the value of JALVIEW_VERSION in various places, including the 'About' and Jalview Desktop window title, and in filenames for the stand-alone executable jar. You can specify a custom version for a build via the JALVIEW_VERSION property, but for most situations, JALVIEW_VERSION will be automatically configured according to the value of the CHANNEL property, using the `jalview.version` property specified in the RELEASE file: - - `CHANNEL=RELEASE` will set version to jalview.version - - `CHANNEL=TEST or DEVELOP` will append '-test' or '-develop' to jalview.version + - `CHANNEL=RELEASE` will set version to jalview.version. + - `CHANNEL=TEST or DEVELOP` will append '-test' or '-develop' to jalview.version. + - `CHANNEL=JALVIEWJS` will use the `channel.props` found in `utils/channels/jalviewjs` but otherwise uses `LOCAL` settings. + - `CHANNEL=JALVIEWJS-RELEASE` uses a symbolic link to `utils/channels/jalviewjs` but otherwise uses `RELEASE` settings. It is also possible to specify a custom location for the RELEASE file via an optional JALVIEW_RELEASE_FILE property.