Skip to content

Commit 872bc9c

Browse files
fvarruifvarrui
committed
U v1.5.1
1 parent 201c696 commit 872bc9c

File tree

1 file changed

+16
-33
lines changed

1 file changed

+16
-33
lines changed

‎README.md

Lines changed: 16 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Add the following `plugin` tag to your `pom.xml`:
2323
<plugin>
2424
<groupId>io.github.fvarrui</groupId>
2525
<artifactId>javapackager</artifactId>
26-
<version>1.5.0</version>
26+
<version>1.5.1</version>
2727
<executions>
2828
<execution>
2929
<phase>package</phase>
@@ -71,7 +71,7 @@ buildscript {
7171
mavenCentral()
7272
}
7373
dependencies {
74-
classpath 'io.github.fvarrui:javapackager:1.5.0'
74+
classpath 'io.github.fvarrui:javapackager:1.5.1'
7575
}
7676
}
7777
@@ -142,33 +142,33 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
142142
| `administratorRequired` | :x: | `false` | App will run as administrator (with elevated privileges). |
143143
| `assetsDir` | :x: | `${basedir}/assets` or `${projectdir}/assets` | Assets location (icons and custom Velocity templates). |
144144
| `bundleJre` | :x: | `false` | Embeds a customized JRE with the app. |
145-
| `classpath` | :x: | `null` | List of additional paths to JVM classpath, separated with `;` (recommended) or `:`. |
145+
| `classpath` | :x: | | List of additional paths to JVM classpath, separated with `;` (recommended) or `:`. |
146146
| `copyDependencies` | :x: | `true` | Bundles all dependencies (JAR files) with the app. |
147147
| `createTarball` | :x: | `false` | Bundles app folder in tarball. |
148148
| `createZipball` | :x: | `false` | Bundles app folder in zipball. |
149149
| `customizedJre` | :x: | `true` | Generates a customized JRE, including only identified or specified modules. Otherwise, all modules will be included. |
150150
| `description` | :x: | `${project.description}` or `${displayName}` | Project description. |
151151
| `displayName` | :x: | `${project.name}` or `${name}` | App name to show. |
152-
| `envPath` | :x: | `null` | Defines PATH environment variable in GNU/Linux and Mac OS X startup scripts. |
153-
| `extra` | :x: | `null` | Map with extra properties to be used in customized Velocity templates, accesible through `$info.extra` variable. |
152+
| `envPath` | :x: | | Defines PATH environment variable in GNU/Linux and Mac OS X startup scripts. |
153+
| `extra` | :x: | | Map with extra properties to be used in customized Velocity templates, accesible through `$info.extra` variable. |
154154
| `generateInstaller` | :x: | `true` | Generates an installer for the app. |
155-
| `iconFile` | :x: | `null` | Path to the app icon file (PNG, XPM, ICO or ICNS). **:warning: Deprecated (see platform specific properties).** |
155+
| `iconFile` | :x: | | Path to the app icon file (PNG, XPM, ICO or ICNS). **:warning: Deprecated (see platform specific properties).** |
156156
| `jdkPath` | :x: | `${java.home}` | JDK used to generate a customized JRE. It allows to bundle customized JREs for different platforms. |
157157
| `jreDirectoryName` | :x: | `"jre"` | Bundled JRE directory name. |
158-
| `jreMinVersion` | :x: | `null` | JRE minimum version. If an appropriate version cannot be found display error message. Disabled if a JRE is bundled. |
158+
| `jreMinVersion` | :x: | | JRE minimum version. If an appropriate version cannot be found display error message. Disabled if a JRE is bundled. |
159159
| `jrePath` | :x: | `""` | Path to JRE folder. If specified, it will bundle this JRE with the app, and won't generate a customized JRE. For Java 8 version or least. |
160160
| `licenseFile` | :x: | `${project.licenses[0].url}` or `${basedir}/LICENSE` or `${projectdir}/LICENSE` | Path to project license file. |
161161
| `mainClass` | :heavy_check_mark: | `${exec.mainClass}` | Full path to your app main class. |
162-
| `manifest` | :x: | `null` | [Allows adding additional entries to MANIFEST.MF file.](docs/manifest.md) |
162+
| `manifest` | :x: | | [Allows adding additional entries to MANIFEST.MF file.](docs/manifest.md) |
163163
| `modules` | :x: | `[]` | Defines modules to customize the bundled JRE. Don't use `jdeps` to get module dependencies. |
164164
| `name` | :x: | `${project.name}` or `${project.artifactId}` | App name. |
165165
| `organizationName` | :x: | `${project.organization.name}` or `"ACME"` | Organization name. |
166166
| `organizationUrl` | :x: | `${project.organization.url}` | Organization website URL. |
167-
| `organizationEmail` | :x: | `null` | Organization email. |
167+
| `organizationEmail` | :x: | | Organization email. |
168168
| `outputDirectory` | :x: | `${project.build.directory}` or `${project.builddir}` | Output directory (where the artifacts will be generated). |
169169
| `platform` | :x: | `auto` | Defines the target platform, which could be different to the execution platform. Possible values: `auto`, `mac`, `linux`, `windows`. Use `auto` for using execution platform as target. |
170-
| `runnableJar` | :x: | `null` | Defines your own JAR file to be bundled. If it's ommited, the plugin packages your code in a runnable JAR and bundle it with the app. |
171-
| `url` | :x: | `null` | App website URL. |
170+
| `runnableJar` | :x: | | Defines your own JAR file to be bundled. If it's ommited, the plugin packages your code in a runnable JAR and bundle it with the app. |
171+
| `url` | :x: | | App website URL. |
172172
| `useResourcesAsWorkingDir` | :x: | `true` | Uses app resources folder as default working directory (always `true` on Mac OS). |
173173
| ` version` | :x: | `${project.version}` | Project version. |
174174
| `vmArgs` | :x: | `[]` | Adds VM arguments. |
@@ -179,13 +179,11 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
179179

180180
| Property | Mandatory | Default | Description |
181181
| ------------- | --------- | ------- | ------------------------------------------------------------ |
182-
| `linuxConfig` | :x: | `null` | [GNU/Linux specific properties](docs/linux-specific-properties.md). |
183-
| `macConfig` | :x: | `null` | [Mac OS X specific properties](docs/macosx-specific-properties.md). |
184-
| `winConfig` | :x: | `null` | [Windows specific properties](docs/windows-specific-properties.md). |
182+
| `linuxConfig` | :x: | | [GNU/Linux specific properties](docs/linux-specific-properties.md). |
183+
| `macConfig` | :x: | | [Mac OS X specific properties](docs/macosx-specific-properties.md). |
184+
| `winConfig` | :x: | | [Windows specific properties](docs/windows-specific-properties.md). |
185185

186-
> See [**Older documentation**](#older-documentation) for previous versions properties.
187-
188-
> :warning: Be careful when using the `platform` property if your project uses platform dependent libraries, so the libraries of the current platform will be copied, not those required for the target platform. You can solve this problem using `classifiers`. Also, customized JRE and intallers generation will be ommited.
186+
> :warning: Be careful when using the `platform` property if your project uses platform dependent libraries, so the libraries of the current platform will be copied, not those required for the target platform. You can solve this problem using `classifiers`. Also, intallers generation will be ommited.
189187
190188
### Plugin assets
191189

@@ -310,19 +308,4 @@ And then, run (ommit `./` on Windows):
310308

311309
Check the [TO-DO list](https://github.com/fvarrui/JavaPackager/projects/1#column-7704117) to know the features we plan to add to JavaPackager.
312310

313-
## Older documentation
314-
315-
- [v1.3.0](https://github.com/fvarrui/JavaPackager/blob/v1.3.0/README.md)
316-
- [v1.2.0](https://github.com/fvarrui/JavaPackager/blob/v1.2.0/README.md)
317-
- [v1.1.0](https://github.com/fvarrui/JavaPackager/blob/v1.1.0/README.md)
318-
- [v1.0.3](https://github.com/fvarrui/JavaPackager/blob/v1.0.3/README.md)
319-
- [v1.0.2](https://github.com/fvarrui/JavaPackager/blob/v1.0.2/README.md)
320-
- [v1.0.1](https://github.com/fvarrui/JavaPackager/blob/v1.0.1/README.md)
321-
- [v1.0.0](https://github.com/fvarrui/JavaPackager/blob/v1.0.0/README.md)
322-
- [v0.9.7](https://github.com/fvarrui/JavaPackager/blob/v0.9.7/README.md)
323-
- [v0.9.6](https://github.com/fvarrui/JavaPackager/blob/v0.9.6/README.md)
324-
- [v0.9.5](https://github.com/fvarrui/JavaPackager/blob/v0.9.5/README.md)
325-
- [v0.9.4](https://github.com/fvarrui/JavaPackager/blob/v0.9.4/README.md)
326-
- [v0.9.3](https://github.com/fvarrui/JavaPackager/blob/v0.9.3/README.md)
327-
- [v0.9.1](https://github.com/fvarrui/JavaPackager/blob/v0.9.1/README.md)
328-
- [v0.9.0](https://github.com/fvarrui/JavaPackager/blob/v0.9.0/README.md)
311+
- https://github.com/fvarrui/JavaPackager/blob/v0.9.0/README.md)

0 commit comments

Comments
 (0)