Skip to content

Commit b50ce38

Browse files
fvarruifvarrui
committed
U docs
1 parent 71eef05 commit b50ce38

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
131131

132132
> :warning: Installers generation will be ommited if target platform is different from current platform (see `platform` property).
133133
134-
> :warning: **DEB and RPM package generation in Gradle is not yet available. Coming soon!**
134+
> :warning: **RPM package generation in Gradle is not yet available. Coming soon!**
135135
136136
### Plugin configuration properties
137137

@@ -153,26 +153,26 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
153153
| `envPath` | :x: | | Defines PATH environment variable in GNU/Linux and Mac OS X startup scripts. |
154154
| `extra` | :x: | | Map with extra properties to be used in customized Velocity templates, accesible through `$info.extra` variable. |
155155
| `generateInstaller` | :x: | `true` | Generates an installer for the app. |
156-
| `iconFile` | :x: | | Path to the app icon file (PNG, XPM, ICO or ICNS). **:warning: Deprecated (see platform specific properties).** |
157156
| `jdkPath` | :x: | `${java.home}` | JDK used to generate a customized JRE. It allows to bundle customized JREs for different platforms. |
158157
| `jreDirectoryName` | :x: | `"jre"` | Bundled JRE directory name. |
159158
| `jreMinVersion` | :x: | | JRE minimum version. If an appropriate version cannot be found display error message. Disabled if a JRE is bundled. |
160159
| `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. |
161160
| `licenseFile` | :x: | `${project.licenses[0].url}` or `${basedir}/LICENSE` or `${projectdir}/LICENSE` | Path to project license file. |
162161
| `mainClass` | :heavy_check_mark: | `${exec.mainClass}` | Full path to your app main class. |
163162
| `manifest` | :x: | | [Allows adding additional entries to MANIFEST.MF file.](docs/manifest.md) |
164-
| `modules` | :x: | `[]` | Defines modules to customize the bundled JRE. Don't use `jdeps` to get module dependencies. |
163+
| `modules` | :x: | `[]` | Modules to customize the bundled JRE. Don't use `jdeps` to get module dependencies. |
165164
| `name` | :x: | `${project.name}` or `${project.artifactId}` | App name. |
166165
| `organizationName` | :x: | `${project.organization.name}` or `"ACME"` | Organization name. |
167166
| `organizationUrl` | :x: | `${project.organization.url}` | Organization website URL. |
168167
| `organizationEmail` | :x: | | Organization email. |
169168
| `outputDirectory` | :x: | `${project.build.directory}` or `${project.builddir}` | Output directory (where the artifacts will be generated). |
169+
| `packagingJdk` | :x: | `${java.home}` | JDK used in the execution of `jlink` and other JDK tools. |
170170
| `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. |
171171
| `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. |
172172
| `url` | :x: | | App website URL. |
173173
| `useResourcesAsWorkingDir` | :x: | `true` | Uses app resources folder as default working directory (always `true` on Mac OS). |
174-
| ` version` | :x: | `${project.version}` | Project version. |
175-
| `vmArgs` | :x: | `[]` | Adds VM arguments. |
174+
| ` version` | :x: | `${project.version}` | App version. |
175+
| `vmArgs` | :x: | `[]` | VM arguments. |
176176

177177
> Some default values depends on the used building tool.
178178

‎docs/linux-specific-properties.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@
66
<xpmFile>path/to/icon.xpm</xpmFile>
77
<generateDeb>true|false</generateDeb>
88
<generateRpm>true|false</generateRpm>
9+
<wrapJar>true|false</wrapJar>
910
</linuxConfig>
1011
```
1112

12-
| Property | Mandatory | Default value | Description |
13-
| ------------- | --------- | ------------- | ------------------------------ |
14-
| `pngFile` | :x: | `null` | Icon file. |
15-
| `xpmFile` | :x: | `null` | Icon file for RPM generation. |
16-
| `generateDeb` | :x: | `true` | DEB package will be generated. |
17-
| `generateRpm` | :x: | `true` | RPM package will be generated. |
13+
14+
15+
| Property | Mandatory | Default value | Description |
16+
| ------------- | --------- | ------------- | ----------------------------------------------- |
17+
| `pngFile` | :x: | `null` | Icon file. |
18+
| `xpmFile` | :x: | `null` | Icon file for RPM generation. |
19+
| `generateDeb` | :x: | `true` | DEB package will be generated. |
20+
| `generateRpm` | :x: | `true` | RPM package will be generated. |
21+
| `wrapJar` | :x: | `true` | Wraps JAR file inside the executable if `true`. |

0 commit comments

Comments
 (0)