Skip to content

Commit 70c6dee

Browse files
committed
Update README.md
1 parent d79b2a5 commit 70c6dee

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

README.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ And by default it will generate next artifacts in `target ` folder:
8181
| `additionalModules` | :x: | `[]` | Additional modules to the ones identified by `jdeps` or the specified with `modules` property. |
8282
| `additionalResources` | :x: | `[]` | Additional files and folders to include in the bundled app. |
8383
| `administratorRequired` | :x: | `false` | App will run as administrator (with elevated privileges). |
84-
| `assetsDir` | :x: | `${basedir}/assets` | Assets location. |
84+
| `assetsDir` | :x: | `${basedir}/assets` | Assets location (icons and custom Velocity templates). |
8585
| `bundleJre` | :x: | `false` | Embeds a customized JRE with the app. |
8686
| `copyDependencies` | :x: | `true` | Bundles all dependencies (JAR files) with the app. |
8787
| `createTarball` | :x: | `false` | Bundles app folder in tarball. |
@@ -126,27 +126,25 @@ And by default it will generate next artifacts in `target ` folder:
126126
Some assets, such as application icons and Velocity templates, could be placed in `${assetsDir}` folder organized by platform.
127127

128128
```
129-
<project>/
130-
└── ${assetsDir}/
131-
├── linux/
132-
├── mac/
133-
└── windows/
129+
${assetsDir}/
130+
├── linux/
131+
├── mac/
132+
└── windows/
134133
```
135134

136135
#### Icons
137136

138137
If icons are located in `${assetsDir}` folders, it would not be necessary to specify the `iconFile` property:
139138

140139
```
141-
<project>/
142-
└── ${assetsDir}/
143-
├── linux/
144-
│   ├── ${name}.png # on GNU/Linux it has to be a PNG file for DEB package
145-
│   └── ${name}.xpm # and XPM file for RPM package
146-
├── mac/
147-
│   └── ${name}.icns # on Mac OS X it has to be a ICNS file
148-
└── windows/
149-
└── ${name}.ico # on Windows it has to be a ICO file
140+
${assetsDir}/
141+
├── linux/
142+
│   ├── ${name}.png # on GNU/Linux it has to be a PNG file for DEB package
143+
│   └── ${name}.xpm # and XPM file for RPM package
144+
├── mac/
145+
│   └── ${name}.icns # on Mac OS X it has to be a ICNS file
146+
└── windows/
147+
└── ${name}.ico # on Windows it has to be a ICO file
150148
```
151149

152150
> :warning: If `iconFile` plugin property is not specified and it can't find the correct icon in `assets` 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.
@@ -159,21 +157,20 @@ If icons are located in `${assetsDir}` folders, it would not be necessary to spe
159157
It is possible to use your own customized templates. You just have to put one of the following templates in the `assets` folder organized by platform, and the plugin will use these templates instead of default ones:
160158

161159
```
162-
<project>/
163-
└── ${assetsDir}/
164-
├── linux/
165-
| ├── control.vtl # DEB control template
166-
| ├── desktop.vtl # Desktop template
167-
│   └── startup.sh.vtl # Startup script template
168-
├── mac/
169-
| ├── customize-dmg.applescript.vtl # Applescript template
170-
| ├── Info.plist.vtl # Info.plist template
171-
│   └── startup.vtl # Startup script template
172-
├── windows/
173-
| ├── exe.manifest.vtl # exe.manifest template
174-
| ├── iss.vtl # Inno Setup Script template
175-
│   └── wxs.vtl # WiX Toolset WXS template
176-
└── assembly.xml.vtl # template for maven-assembly-plugin
160+
${assetsDir}/
161+
├── linux/
162+
| ├── control.vtl # DEB control template
163+
| ├── desktop.vtl # Desktop template
164+
│   └── startup.sh.vtl # Startup script template
165+
├── mac/
166+
| ├── customize-dmg.applescript.vtl # Applescript template
167+
| ├── Info.plist.vtl # Info.plist template
168+
│   └── startup.vtl # Startup script template
169+
├── windows/
170+
| ├── exe.manifest.vtl # exe.manifest template
171+
| ├── iss.vtl # Inno Setup Script template
172+
│   └── wxs.vtl # WiX Toolset WXS template
173+
└── assembly.xml.vtl # template for maven-assembly-plugin
177174
```
178175

179176
> Use [default templates](https://github.com/fvarrui/JavaPackager/tree/master/src/main/resources) as examples.

0 commit comments

Comments
 (0)