[datasketches-memory] branch single-build-script updated: Add documentation for standalone JAR script

[dc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dcromberge pushed a commit to branch single-build-script
in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git


The following commit(s) were added to refs/heads/single-build-script by this push:
     new 0af5fdd  Add documentation for standalone JAR script
0af5fdd is described below

commit 0af5fdd81a77cbcfc9495b369119504fbb60e2eb
Author: David Cromberge <dc...@apache.org>
AuthorDate: Wed Sep 1 16:46:03 2021 +0100

    Add documentation for standalone JAR script
---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f57d32a..18d1ae2 100644
--- a/README.md
+++ b/README.md
@@ -65,12 +65,18 @@ __NOTE:__
    For more information, see this [Maven Reactor Issue](https://issues.apache.org/jira/browse/MNG-3283).
 
 ### JDK versions required to compile
-This DataSketches component is pure Java and requires the following JDKs to compile:
+This DataSketches component is pure Java and requires any a JDK hotspot version between 8 and 13 to compile.
+Refer to the section below for instructions on how to build a standalone JAR using a single JDK version.
+
+### JDK versions required to compile the Multi-release JAR
+The following versions of the JDK are all required to compile the multi-release JAR:
 
 - JDK8/Hotspot
 - JDK9/Hotspot
 - JDK11/Hotspot
 
+These versions are also required in order to build the Maven project in an IDE.
+
 Ensure that your local environment has been configured according to the 
 [Maven Toolchains Configuration](docs/maven-toolchains.md).
 
@@ -112,6 +118,20 @@ This will create the following Jars:
 * datasketches-memory-X.Y.Z-test-sources.jar The test source files
 * datasketches-memory-X.Y.Z-javadoc.jar  The compressed Javadocs.
 
+### Building a standalone JAR using a single version of the JDK
+A shell script is provided to compile and build a JAR for situations where it is not possible to
+install multiple versions of the JDK in the same build environment.
+
+This script can be found in the **tools/scripts** directory and is invoked from the command line as follows:
+
+    $ ./tools/scripts/compile-package-jar.sh JAVA_HOME GIT_VERSION PROJECT_BASE_DIR
+
+Where:
+
+1) The first argument is the absolute path of JDK home directory e.g. $JAVA_HOME
+2) The second argument is the Git Version Tag for this deployment e.g. 1.0.0-SNAPSHOT, 1.0.0-RC1, 1.0.0 etc.
+3) The third argument is the absolute path of project.basedir e.g. /src/apache-datasketches-memory
+
 ### Toolchains
 
 This project makes use of Maven toolchains to ensure that the correct Java compiler version is 

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org