Updating README.md and CHANGELOG.md #22

Merged
David merged 1 commits from feature/update_readme_file into develop 2024-05-20 20:09:26 +02:00
2 changed files with 12 additions and 4 deletions

View File

@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [1.0.0] - 2024-05-20 ## [1.0.0] - 2024-05-20
### Added ### Added
- Install script improved to run with /bin/sh - Install script improved to run with /bin/sh
- Dockerfile changed to use install script (Works on x64 and aarch64 architecture) - Dockerfile changed to use install.sh script (Works on x64 and aarch64 architecture)
- Dockerfile_x64 with old build script for tests - Dockerfile_x64 with old build script for tests
- Script warp4j improved to support to run on aarch64 architecture - Script warp4j improved to support to run on aarch64 architecture

View File

@ -20,7 +20,7 @@ Just put both `warp4j` and `warp-packer` somewhere in your PATH and run `warp4j
Curl one-liner installs latest versions of both `warp4j` and `warp-packer`: Curl one-liner installs latest versions of both `warp4j` and `warp-packer`:
``` ```
$ bash -c "$(curl -fsSL https://git.phoenix.ipv64.de/public/warp4j/raw/branch/master/install)" bash -c "$(curl -fsSL https://git.phoenix.ipv64.de/public/warp4j/raw/branch/master/install.sh)"
``` ```
This script will show missing dependencies (if there are any), they must be installed with your package manager. This script will show missing dependencies (if there are any), they must be installed with your package manager.
@ -56,6 +56,7 @@ See help:
``` ```
$ wapr4j --help $ wapr4j --help
Usage: warp4j [options] <app.jar> Usage: warp4j [options] <app.jar>
Turn JAR (java archive) into self-contained executable Turn JAR (java archive) into self-contained executable
@ -69,10 +70,17 @@ Options:
adds additional classpaths to the jdeps call adds additional classpaths to the jdeps call
--auto-class-path extract and get class-path values from jar file --auto-class-path extract and get class-path values from jar file
ignored when -cp, --class-path is set ignored when -cp, --class-path is set
--spring-boot extract and get class-path values from
Spring-Boot application jar file
ignored when -cp, --class-path is set
-o, --output <directory> -o, --output <directory>
override output directory; override output directory;
this is relative to current PWD this is relative to current PWD
(default: ./warped) (default: ./warped)
-p, --prefix <prefix>
if set, warp-packer will use the prefix
as target folder in which the
application should be extracted
--list show available java releases; --list show available java releases;
takes into consideration other options: takes into consideration other options:
"--java-version", "--no-optimize", "--jvm-impl"; "--java-version", "--no-optimize", "--jvm-impl";
@ -85,13 +93,12 @@ Options:
--pull check if more recent JDK/JRE distro is available; --pull check if more recent JDK/JRE distro is available;
by default latest cached version that matches by default latest cached version that matches
"--java-version" is used "--java-version" is used
to get the classpath for jdeps call
--linux create binary for Linux --linux create binary for Linux
--macos create binary for macOS --macos create binary for macOS
--windows create binary for Windows --windows create binary for Windows
if no targets are specified then binaries for if no targets are specified then binaries for
all targets are created all targets are created
--jvm-impl jvm implementation: hotspot or openj9
(default: hotspot)
--jvm-options <options> --jvm-options <options>
passed to java like this: passed to java like this:
"java <options> -jar <jar file>"; "java <options> -jar <jar file>";
@ -99,6 +106,7 @@ Options:
example: '-Xms512m -Xmx1024m' example: '-Xms512m -Xmx1024m'
-s, --silent using javaw instead of java for windows -s, --silent using javaw instead of java for windows
-h, --help show this message -h, --help show this message
``` ```
## Compatibility ## Compatibility