X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=doc%2Fbuilding.md;h=8e21d5778379ac7aa8554cb364416b1ecc86eb05;hb=fa9da54fb97cb2eacb1af7859024d90166bddb8f;hp=f2d832a934e6fbc6cd34275f78fa21769f5d9668;hpb=435bdfd0a2072ee6562d15eb3c9676eaba1b7a1b;p=jalview.git diff --git a/doc/building.md b/doc/building.md index f2d832a..8e21d57 100644 --- a/doc/building.md +++ b/doc/building.md @@ -484,19 +484,21 @@ 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: - a file `channel_gradle.properties`. This will be used by the `build.gradle` script (i.e. any gradle build) to *override* the values found in `gradle.properties`. - an `images` directory used to store different images referred to in this channels's `channel_gradle.properties`. -- a `resources` directory which is merged into the javliew.jar's own resources directory. Importantly it contains a `channel_properties` file and another `images` dir which contains properties and images used by the application (in `jalview.util.ChannelProperties`), such as icon files or banner images, and the `app_name` property used as the display name for the application (e.g. "Jalview Develop") inside the application code. Please see the `getProperty` and `getImage` methods in `jalview.bin.ChannelProperties` to access these channel based resources. +- a `resources` directory which is merged into the javliew.jar's own resources directory. Importantly it contains a `channel.props` file and another `images` dir which contains properties and images used by the application (in `jalview.util.ChannelProperties`), such as icon files or banner images, and the `app_name` property used as the display name for the application (e.g. "Jalview Develop") inside the application code. Please see the `getProperty` and `getImage` methods in `jalview.bin.ChannelProperties` to access these channel based resources. #### 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.