public/warp4j
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Updating CHANGELOG.md, adding infos to README.md and improving help

Browse Source
This commit is contained in:
david 2024-05-31 15:08:43 +02:00
parent 0966dd2d2e
commit 85898ce5f2
3 changed files with 99 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -6,13 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [Unreleased]
### Changed
- Improved macOS runnable execution in the tar.gz file. The executable file is now placed inside a folder named `application.app`, allowing it to be launched with a double-click.
## [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.sh 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
### Changed
- Script warp4j improved to support running on aarch64 architecture
## [origin warp4j] - 2019-02-28 ## [origin warp4j] - 2019-02-28
- See origin repository: https://github.com/guziks/warp4j - See origin repository: https://github.com/guziks/warp4j

106
README.md
View File

@ -4,12 +4,12 @@ Turn JAR (java archive) into self-contained executable in a single command.
## Features ## Features
- downloads java runtimes automatically - Downloads Java runtimes automatically
- makes runtimes optimized for your application - Makes runtimes optimized for your application
- creates self-contained binaries for Linux, macOS and Windows using [warp-packer](https://git.phoenix.ipv64.de/public/warp) - Creates self-contained binaries for Linux, macOS, and Windows using [warp-packer](https://git.phoenix.ipv64.de/public/warp)
- works on Linux, macOS and Windows (with Windows Subsystem for Linux) - Works on Linux, macOS, and Windows (with Windows Subsystem for Linux)
- supports cross "compilation" - Supports cross "compilation"
- does not require neither JDK nor JRE installed - Does not require either JDK or JRE installed
## TL;DR ## TL;DR
@ -17,19 +17,19 @@ Just put both `warp4j` and `warp-packer` somewhere in your PATH and run `warp4j
## Install ## Install
Curl one-liner installs latest versions of both `warp4j` and `warp-packer`: Curl one-liner installs the latest versions of both `warp4j` and `warp-packer`:
``` ```sh
bash -c "$(curl -fsSL https://git.phoenix.ipv64.de/public/warp4j/raw/branch/master/install.sh)" 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.
See more install methods [here](INSTALL.md). See more install methods [here](INSTALL.md).
## Usage ## Usage
``` ```sh
$ ls $ ls
my-app.jar my-app.jar
@ -53,62 +53,84 @@ my-app-windows-x64.zip
See help: See help:
``` ```sh
$ wapr4j --help $ warp4j --help
Usage: warp4j [options] <app.jar> Usage: warp4j [options] <app.jar>
Turn JAR (java archive) into self-contained executable Turn JAR (java archive) into a self-contained executable
Options: Options:
-j, --java-version <version> -j, --java-version <version>
override JDK/JRE version Override JDK/JRE version
examples: "17", "17.0", "17.0.2", "17.0.2+9" Examples: "17", "17.0", "17.0.2", "17.0.2+9"
(default: 17) (default: 17)
-cp, --class-path <classpath> -cp, --class-path <classpath>
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 Extract and get class-path values from
Spring-Boot application jar file Spring-Boot application jar file
ignored when -cp, --class-path is set 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> -p, --prefix <prefix>
if set, warp-packer will use the prefix If set, warp-packer will use the prefix
as target folder in which the as target folder in which the
application should be extracted 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";
the output may be used to specify concrete The output may be used to specify concrete
"--java-version" "--java-version"
--no-optimize use JRE instead of optimized JDK; --no-optimize Use JRE instead of optimized JDK;
by default jdeps and jlink are used to create By default jdeps and jlink are used to create
optimized JDK for the particular jar; optimized JDK for the particular jar;
JRE is always used for java 8 JRE is always used for java 8
--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-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>";
use quotes when passing multiple options Use quotes when passing multiple 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
``` ```
### Running on macOS
For macOS, the executable is placed inside a folder with the `.app` extension within the tar.gz file. This allows the application to be launched with a double-click.
To run the application:
1. **From the Executable**:
- Navigate to the `warped` folder.
- Find the `my-app-macos-x64` executable.
- Note: Double-clicking on “my-app-macos-x64” does not work directly because macOS does not know which program to use to open the application.
- To run it, open the terminal and navigate to the `warped` folder:
```sh
cd /path/to/warped
```
- Run the executable from the terminal:
```sh
./my-app-macos-x64
```
2. **From the tar.gz File**:
- Extract the `my-app-macos-x64.tar.gz` file.
- Navigate to the extracted folder: `my-app-macos-x64`.
- You will find a folder named `my-app.app`. For macOS this is now an executable file.
- Double-click on `my-app.app` to run the application.
## Compatibility ## Compatibility
Tested on the following operating systems: Tested on the following operating systems:

55
warp4j
View File

@ -4,53 +4,52 @@ function print_help {
echo echo
echo 'Usage: warp4j [options] <app.jar>' echo 'Usage: warp4j [options] <app.jar>'
echo echo
echo 'Turn JAR (java archive) into self-contained executable' echo 'Turn JAR (java archive) into a self-contained executable'
echo echo
echo 'Options:' echo 'Options:'
echo ' -j, --java-version <version>' echo ' -j, --java-version <version>'
echo ' override JDK/JRE version' echo ' Override JDK/JRE version'
echo ' examples: "17", "17.0", "17.0.2", "17.0.2+9"' echo ' Examples: "17", "17.0", "17.0.2", "17.0.2+9"'
echo ' (default: 17)' echo ' (default: 17)'
echo ' -cp, --class-path <classpath>' echo ' -cp, --class-path <classpath>'
echo ' adds additional classpaths to the jdeps call' echo ' Adds additional classpaths to the jdeps call'
echo ' --auto-class-path extract and get class-path values from jar file' echo ' --auto-class-path Extract and get class-path values from jar file'
echo ' ignored when -cp, --class-path is set' echo ' Ignored when -cp, --class-path is set'
echo ' --spring-boot extract and get class-path values from' echo ' --spring-boot Extract and get class-path values from'
echo ' Spring-Boot application jar file' echo ' Spring-Boot application jar file'
echo ' ignored when -cp, --class-path is set' echo ' Ignored when -cp, --class-path is set'
echo ' -o, --output <directory>' echo ' -o, --output <directory>'
echo ' override output directory;' echo ' Override output directory;'
echo ' this is relative to current PWD' echo ' This is relative to current PWD'
echo ' (default: ./warped)' echo ' (default: ./warped)'
echo ' -p, --prefix <prefix>' echo ' -p, --prefix <prefix>'
echo ' if set, warp-packer will use the prefix' echo ' If set, warp-packer will use the prefix'
echo ' as target folder in which the' echo ' as target folder in which the'
echo ' application should be extracted' echo ' application should be extracted'
echo ' --list show available java releases;' echo ' --list Show available java releases;'
echo ' takes into consideration other options:' echo ' Takes into consideration other options:'
echo ' "--java-version", "--no-optimize", "--jvm-impl";' echo ' "--java-version", "--no-optimize", "--jvm-impl";'
echo ' the output may be used to specify concrete' echo ' The output may be used to specify concrete'
echo ' "--java-version"' echo ' "--java-version"'
echo ' --no-optimize use JRE instead of optimized JDK;' echo ' --no-optimize Use JRE instead of optimized JDK;'
echo ' by default jdeps and jlink are used to create' echo ' By default jdeps and jlink are used to create'
echo ' optimized JDK for the particular jar;' echo ' optimized JDK for the particular jar;'
echo ' JRE is always used for java 8' echo ' JRE is always used for java 8'
echo ' --pull check if more recent JDK/JRE distro is available;' echo ' --pull Check if more recent JDK/JRE distro is available;'
echo ' by default latest cached version that matches' echo ' By default latest cached version that matches'
echo ' "--java-version" is used' echo ' "--java-version" is used'
echo ' to get the classpath for jdeps call' echo ' --linux Create binary for Linux'
echo ' --linux create binary for Linux' echo ' --macos Create binary for macOS'
echo ' --macos create binary for macOS' echo ' --windows Create binary for Windows'
echo ' --windows create binary for Windows' echo ' If no targets are specified then binaries for'
echo ' if no targets are specified then binaries for'
echo ' all targets are created' echo ' all targets are created'
echo ' --jvm-options <options>' echo ' --jvm-options <options>'
echo ' passed to java like this:' echo ' Passed to java like this:'
echo ' "java <options> -jar <jar file>";' echo ' "java <options> -jar <jar file>";'
echo ' use quotes when passing multiple options' echo ' Use quotes when passing multiple options'
echo " example: '-Xms512m -Xmx1024m'" echo " Example: '-Xms512m -Xmx1024m'"
echo ' -s, --silent using javaw instead of java for windows' echo ' -s, --silent Using javaw instead of java for windows'
echo ' -h, --help show this message' echo ' -h, --help Show this message'
exit exit
} }