Skip to content

Commit cc71856

Browse files
committed
Update README.md
1 parent b2abc58 commit cc71856

File tree

1 file changed

+45
-14
lines changed

1 file changed

+45
-14
lines changed

README.md

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Add the following `plugin` tag to your `pom.xml`:
1515
<plugin>
1616
<groupId>io.github.fvarrui</groupId>
1717
<artifactId>javapackager</artifactId>
18-
<version>0.9.5|0.9.6-SNAPSHOT</version>
18+
<version>0.9.6|0.9.7-SNAPSHOT</version>
1919
<executions>
2020
<execution>
2121
<phase>package</phase>
@@ -103,19 +103,27 @@ And by default it will generate next artifacts in `target ` folder:
103103
| `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. |
104104
| `url` | :x: | `null` | App website URL. |
105105
| ` version` | :x: | `${project.version}` | Project version. |
106-
| `versionInfo` | :x: | `null` | [Version information](#version-information-property-example) for native Windows `.exe` file. |
106+
| `versionInfo` | :x: | `null` | Version information for native Windows `.exe` file. :warning: **Deprecated. Use `winConfig` instead**. |
107107
| `vmArgs` | :x: | `[]` | Adds VM arguments. |
108108

109+
**Platform specific properties**
110+
111+
| Property | Mandatory | Default | Description |
112+
| ----------- | --------- | ------- | ------------------------------------------------------------ |
113+
| `macConfig` | :x: | `null` | [Mac OS X specific configuration](#mac-os-x-config-property) properties. |
114+
| `winConfig` | :x: | `null` | [Windows specific configuration](#windows-config-property) properties. |
115+
109116
> See [**Older documentation**](#older-documentation) for previous versions properties.
110117
111118
> :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 generation will be ommited.
112119
113-
#### Version information property example
120+
### Platform specific properties
114121

115-
Using default values:
122+
#### Windows config property
116123

117124
```xml
118-
<versionInfo>
125+
<winConfig>
126+
<!-- properties used in EXE generation by launch4j -->
119127
<fileVersion>1.0.0.0</fileVersion>
120128
<txtFileVersion>${version}</txtFileVersion>
121129
<productVersion>1.0.0.0</productVersion>
@@ -125,7 +133,28 @@ Using default values:
125133
<productName>${name}</productName>
126134
<internalName>${name}</internalName>
127135
<originalFilename>${name}.exe</originalFilename>
128-
</versionInfo>
136+
</winConfig>
137+
```
138+
139+
#### Mac OS X config property
140+
141+
```xml
142+
<macConfig>
143+
<!-- properties used in DMG disk image generation -->
144+
<backgroundImage>path/to/png</backgroundImage>
145+
<windowX>x</windowX>
146+
<windowY>y</windowY>
147+
<windowWidth>width</windowWidth>
148+
<windowHeight>height</windowHeight>
149+
<iconSize>size</iconSize>
150+
<textSize>size</textSize>
151+
<iconX>x</iconX>
152+
<iconY>y</iconY>
153+
<appsLinkIconX>x</appsLinkIconX>
154+
<appsLinkIconY>y</appsLinkIconY>
155+
<volumeIcon>path/to/icns</volumeIcon>
156+
<volumeName>${name}</volumeName>
157+
</macConfig>
129158
```
130159

131160
### Plugin assets
@@ -169,16 +198,17 @@ It is possible to use your own customized templates. You just have to put one of
169198
<project>/
170199
└── assets/
171200
├── linux/
172-
| ├── control.vtl # DEB control template
173-
| ├── desktop.vtl # Desktop template
174-
│   └── startup.sh.vtl # Startup script template
201+
| ├── control.vtl # DEB control template
202+
| ├── desktop.vtl # Desktop template
203+
│   └── startup.sh.vtl # Startup script template
175204
├── mac/
176-
| ├── Info.plist.vtl # Info.plist template
177-
│   └── startup.vtl # Startup script template
205+
| ├── customize-dmg.applescript.vtl # Applescript template
206+
| ├── Info.plist.vtl # Info.plist template
207+
│   └── startup.vtl # Startup script template
178208
├── windows/
179-
| ├── exe.manifest.vtl # exe.manifest template
180-
│   └── iss.vtl # Inno Setup Script template
181-
└── assembly.xml.vtl # assembly.xml template for maven-assembly-plugin
209+
| ├── exe.manifest.vtl # exe.manifest template
210+
│   └── iss.vtl # Inno Setup Script template
211+
└── assembly.xml.vtl # template for maven-assembly-plugin
182212
```
183213

184214
> Use [default templates](https://github.com/fvarrui/JavaPackager/tree/master/src/main/resources) as examples.
@@ -240,6 +270,7 @@ Check the [TO-DO list](https://github.com/fvarrui/JavaPackager/projects/1#column
240270

241271
## Older documentation
242272

273+
- [v0.9.5](https://github.com/fvarrui/JavaPackager/blob/v0.9.5/README.md)
243274
- [v0.9.4](https://github.com/fvarrui/JavaPackager/blob/v0.9.4/README.md)
244275
- [v0.9.3](https://github.com/fvarrui/JavaPackager/blob/v0.9.3/README.md)
245276
- [v0.9.1](https://github.com/fvarrui/JavaPackager/blob/v0.9.1/README.md)

0 commit comments

Comments
 (0)