Skip to content

Commit f2c628f

Browse files
committed
Update README.md
1 parent 14f7c6c commit f2c628f

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,20 @@ gradle packageMyApp
115115

116116
By default it will generate next artifacts in `${outputDirectory} ` folder:
117117

118-
| Artifact | Description |
119-
| --------------------------------------- | ------------------------------------------------------------ |
120-
| `${name}` | Directory with the native application and other needed assets. |
121-
| `${name}-${version}-runnable.jar` | Runnable JAR file. |
122-
| `${name}_${version}.deb` | DEB package file if it's executed on GNU/Linux. |
123-
| `${name}_${version}.rpm` | RPM package file if it's executed on GNU/Linux. |
124-
| `${name}_${version}.exe` | Setup file if it's executed on Windows (requires [**Inno Setup**](http://www.jrsoftware.org/isinfo.php)). |
125-
| `${name}_${version}.msi` | MSI installer file if it's executed on Windows (requires **[WiX Toolset](https://wixtoolset.org/)**). |
126-
| `${name}_${version}.msm` | MSI merge module file if it's executed on Windows (requires **[WiX Toolset](https://wixtoolset.org/)**). |
127-
| `${name}_${version}.dmg` | Disk image file if it's executed on Mac OS X (requires **hdiutil**). |
128-
| `${name}_${version}.pkg` | PKG installer file if it's executed on Mac OS X (requires **pkgbuild**) |
129-
| `${name}-${version}-${platform}.zip` | Zipball containing generated directory `${name}`. |
130-
| `${name}-${version}-${platform}.tar.gz` | Compressed tarball containing generated directory `${name}`. |
131-
132-
> :warning: **Some installers generation will be ommited if target platform is different from current platform (see `platform` property), except for DEB and RPM packages.**
118+
| Artifact | Description | Platform | Requires |
119+
| --------------------------------------- | ------------------------------------------------------------ | -------- | -------------------------------------------------- |
120+
| `${name}` | Directory with native application and other assets. | All | |
121+
| `${name}-${version}-runnable.jar` | Runnable JAR file. | All | |
122+
| `${name}_${version}.deb` | DEB package file. | All | |
123+
| `${name}_${version}.rpm` | RPM package file. | All | |
124+
| `${name}_${version}.exe` | Setup file. | Window | [Inno Setup](http://www.jrsoftware.org/isinfo.php) |
125+
| `${name}_${version}.msi` | MSI installer file. | Windows | [WiX Toolset](https://wixtoolset.org/) |
126+
| `${name}_${version}.msm` | MSI merge module file. | Windows | [WiX Toolset](https://wixtoolset.org/) |
127+
| `${name}_${version}.dmg` | Disk image file (uses **hdiutil**). | Mac OS X | |
128+
| `${name}_${version}.pkg` | PKG installer file (uses **pkgbuild**). | Mac OS X | |
129+
| `${name}-${version}-${platform}.zip` | Zipball containing generated directory `${name}`. | All | |
130+
| `${name}-${version}-${platform}.tar.gz` | Compressed tarball containing generated directory `${name}`. | All | |
131+
| `assets` | Directory with all intermediate files generated by JavaPackager. | All | |
133132

134133
### Plugin configuration properties
135134

@@ -236,14 +235,14 @@ ${assetsDir}/
236235
├── exe.manifest.vtl # exe.manifest template
237236
├── iss.vtl # Inno Setup Script template
238237
├── msm.wxs.vtl # WiX Toolset WXS template to generate Merge Module
239-
├── startup.vbs.vtl # VBS bootstrap script template
238+
├── startup.vbs.vtl # Startup script template (VB Script)
240239
   └── wxs.vtl # WiX Toolset WXS template to generate MSI
241240
```
242241

243-
> Use [default templates](https://github.com/fvarrui/JavaPackager/tree/master/src/main/resources) as examples.
244-
245242
An object called `info` of type [`PackagerSettings`](https://github.com/fvarrui/JavaPackager/blob/master/src/main/java/io/github/fvarrui/javapackager/packagers/PackagerSettings.java) is passed to all templates with all plugin properties.
246243

244+
You can use [default templates](https://github.com/fvarrui/JavaPackager/tree/master/src/main/resources) as examples to create your own templates, and use the `extra` map property to add your own properties in the plugin settings to use in your custom templates (e.g. `${info.extra["myProperty"]}`).
245+
247246
### Additional JVM options at runtime
248247

249248
When you build your app, all configuration details are hardcoded into the executable and cannot be changed without recreating it or hacking with a resource editor. JavaPackager introduces a feature that allows to pass additional JVM options at runtime from an `.l4j.ini` file (like [Launch4j](http://launch4j.sourceforge.net/docs.html) does, but available for all platforms in the same way). So, you can specify these options in the packager's configuration (packaging time), in INI file (runtime) or in both.

0 commit comments

Comments
 (0)