From f3dcb2f8f602117ac390799b1f310dcaa9918592 Mon Sep 17 00:00:00 2001 From: Ben Soares Date: Thu, 29 Oct 2020 14:19:51 +0000 Subject: [PATCH] JAL-3248 Fixed path typos in building.md/html and corrected shadow jar filename --- doc/building.html | 11 ++++++----- doc/building.md | 13 ++++++++----- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/doc/building.html b/doc/building.html index c128e2d..28206a6 100644 --- a/doc/building.html +++ b/doc/building.html @@ -775,7 +775,7 @@ git clone http://source.jalview.org/git/jalview.git cd jalview gradle shadowJar # run -java -jar build/libs/jalview-all-11.jar +java -jar build/libs/jalview-all-*-j11.jar # and/or create launcher gradle getdown @@ -964,11 +964,12 @@ brew cask install adoptopenjdk11 
java -cp "dist/*" jalview.bin.Jalview

Single shadow Jar File

The shadow jar file is a single .jar that contains all required classes and resources from jalview.jar and all of the supporting libraries in j11lib/*.jar merged into one .jar archive file. A default launching class (MAIN-CLASS: jalview.bin.Launcher) is specified in the .jar manifest file (META/MANIFEST.MF) so a start class doesn’t need to be specified.

-

Build the shadow jar file in build/lib/jalview-all-11.jar with

+

Build the shadow jar file in build/libs/jalview-all-VERSION-j11.jar with

gradle shadowJar
-

and run it with

-
java -jar build/lib/jalview-all-11.jar
-

Because no arguments are required, most OSes will associate a .jar file with the java application (if this has been installed through the OS and not just a local unzip) as a -jar argument so you may find you can launch jalview-all-11.jar just by double-clicking on it)!

+

NB VERSION will be replaced with a version number or “DEVELOPMENT” depending on how the branch is set up.

+

Run it with

+
java -jar build/libs/jalview-all-VERSION-j11.jar
+

Because no arguments are required, most OSes will associate a .jar file with the java application (if this has been installed through the OS and not just a local unzip) as a -jar argument so you may find you can launch jalview-all-VERSION-j11.jar just by double-clicking on it)!

The shadowJar task is not a requirement for any other task, so to build the shadow jar file you must specify the shadowJar task.

diff --git a/doc/building.md b/doc/building.md index 6cd2395..497e722 100644 --- a/doc/building.md +++ b/doc/building.md @@ -9,7 +9,7 @@ git clone http://source.jalview.org/git/jalview.git cd jalview gradle shadowJar # run -java -jar build/libs/jalview-all-11.jar +java -jar build/libs/jalview-all-*-j11.jar # and/or create launcher gradle getdown @@ -248,20 +248,23 @@ and all of the supporting libraries in `j11lib/*.jar` merged into one `.jar` arc file. A default launching class (`MAIN-CLASS: jalview.bin.Launcher`) is specified in the `.jar` manifest file (`META/MANIFEST.MF`) so a start class doesn't need to be specified. -Build the shadow jar file in `build/lib/jalview-all-11.jar` with +Build the shadow jar file in `build/libs/jalview-all-VERSION-j11.jar` with ```bash gradle shadowJar ``` -and run it with + +__NB__ `VERSION` will be replaced with a version number or "`DEVELOPMENT`" depending on how the branch is set up. + +Run it with ```bash -java -jar build/lib/jalview-all-11.jar +java -jar build/libs/jalview-all-VERSION-j11.jar ``` Because no arguments are required, most OSes will associate a `.jar` file with the `java` application (if this has been installed through the OS and not just a local -unzip) as a `-jar` argument so you may find you can launch `jalview-all-11.jar` +unzip) as a `-jar` argument so you may find you can launch `jalview-all-VERSION-j11.jar` just by double-clicking on it)! > The `shadowJar` task is not a requirement for any other task, so to build the shadow -- 1.7.10.2