Skip to content

Commit 1f1b0c6

Browse files
committed
Update README.md
1 parent 8a77c7d commit 1f1b0c6

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,17 +119,17 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
119119
| --------------------------------------- | ------------------------------------------------------------ |
120120
| `${name}` | Directory with the native application and other needed assets. |
121121
| `${name}-${version}-runnable.jar` | Runnable JAR file. |
122-
| `${name}_${version}.deb` | DEB package file if it's executed on GNU/Linux (requires **dpkg-deb**). |
123-
| `${name}_${version}.rpm` | RPM package file if it's executed on GNU/Linux (requires **rpmbuild**). |
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. |
124124
| `${name}_${version}.exe` | Setup file if it's executed on Windows (requires [**Inno Setup**](http://www.jrsoftware.org/isinfo.php)). |
125125
| `${name}_${version}.msi` | MSI installer file if it's executed on Windows (requires **[WiX Toolset](https://wixtoolset.org/)**). |
126126
| `${name}_${version}.msm` | MSI merge module file if it's executed on Windows (requires **[WiX Toolset](https://wixtoolset.org/)**). |
127127
| `${name}_${version}.dmg` | Disk image file if it's executed on Mac OS X (requires **hdiutil**). |
128128
| `${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}`.**** |
129+
| `${name}-${version}-${platform}.zip` | Zipball containing generated directory `${name}`. |
130130
| `${name}-${version}-${platform}.tar.gz` | Compressed tarball containing generated directory `${name}`. |
131131

132-
> :warning: **Installers generation will be ommited if target platform is different from current platform (see `platform` property), except DEB and RPM packages.**
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.**
133133
134134
### Plugin configuration properties
135135

@@ -167,6 +167,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
167167
| `packagingJdk` | :x: | `${java.home}` | JDK used in the execution of `jlink` and other JDK tools. |
168168
| `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. |
169169
| `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. |
170+
| `scripts` | :x: | | Specify bootstrap script. **Pre and post-install scripts comming soon!** |
170171
| `url` | :x: | | App website URL. |
171172
| `useResourcesAsWorkingDir` | :x: | `true` | Uses app resources folder as default working directory (always `true` on Mac OS). |
172173
| ` version` | :x: | `${project.version}` | App version. |
@@ -186,7 +187,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
186187
187188
### Plugin assets
188189

189-
Some assets, such as application icons and Velocity templates, could be placed in `${assetsDir}` folder organized by platform.
190+
Some assets, such as application icons and templates, could be placed in `${assetsDir}` folder organized by platform.
190191

191192
```bash
192193
${assetsDir}/
@@ -197,23 +198,22 @@ ${assetsDir}/
197198

198199
#### Icons
199200

200-
If icons are located in `${assetsDir}` folders, it would not be necessary to specify the `iconFile` property:
201+
If icons are located in `${assetsDir}` folder, it would not be necessary to use icon properties:
201202

202203
```bash
203204
${assetsDir}/
204205
├── linux/
205-
│   ├── ${name}.png # on GNU/Linux it has to be a PNG file for DEB package
206-
│   └── ${name}.xpm # and XPM file for RPM package
206+
│   └── ${name}.png # on GNU/Linux it has to be a PNG file
207207
├── mac/
208208
│   └── ${name}.icns # on Mac OS X it has to be a ICNS file
209209
└── windows/
210210
└── ${name}.ico # on Windows it has to be a ICO file
211211
```
212212

213-
> :warning: If `iconFile` plugin property is not specified and it can't find the correct icon in `${assetsDir}` folder, it will use an [icon by default](https://raw.githubusercontent.com/fvarrui/JavaPackager/master/src/main/resources/linux/default-icon.png) for all platforms.
213+
> :warning: If icon is not specified , it will use an [icon by default](https://raw.githubusercontent.com/fvarrui/JavaPackager/master/src/main/resources/linux/default-icon.png) for all platforms.
214214
>
215215
216-
#### Velocity templates
216+
#### Templates
217217

218218
[Velocity](https://velocity.apache.org/engine/2.0/user-guide.html) templates (`.vtl` files) are used to generate some artifacts which have to be bundled with the app.
219219

@@ -236,6 +236,7 @@ ${assetsDir}/
236236
├── exe.manifest.vtl # exe.manifest template
237237
├── iss.vtl # Inno Setup Script template
238238
├── msm.wxs.vtl # WiX Toolset WXS template to generate Merge Module
239+
├── startup.vbs.vtl # VBS bootstrap script template
239240
   └── wxs.vtl # WiX Toolset WXS template to generate MSI
240241
```
241242

0 commit comments

Comments
 (0)