Skip to content

Commit 24efd35

Browse files
fvarruifvarrui
committed
Update README.md
1 parent 4697106 commit 24efd35

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

‎README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55

66
JavaPackager is a hybrid plugin for **Maven** and **Gradle** which provides an easy way to package Java applications in native Windows, MacOS or GNU/Linux executables, and generate installers for them.
77

8-
> SNAPSHOT version is not released to Maven Central, so you have to [install it manually](#how-to-build-and-install-the-plugin).
8+
> SNAPSHOT version (available in `devel` branch) is not released to Maven Central, so you have to [install it manually](#how-to-build-and-install-the-plugin).
99
1010
> :eyes: See [JavaPackager changes and fixes](https://github.com/fvarrui/JavaPackager/releases).
1111
1212
## History
1313

14-
It was born while teaching to my students how to build and distribute their Java apps, and after seeing that a chain of several plugins was needed to achieve this task, I decided to develop a plugin :ring: to govern them all.
14+
It was born while teaching to my students how to build and distribute their Java apps, and after seeing that a chain of several plugins was needed to achieve this task, I decided to develop a plugin :ring: to rule them all.
1515

1616
## Apps packaged with JavaPackager
1717

18-
- [Spektar Design Lab](https://spektar.io/)
18+
- [AstroImageJ](http://astroimagej.com/)
1919
- [Astro Pixel Processor](https://www.astropixelprocessor.com/)
2020
- [GistFX](https://github.com/RedmondSims/GistFX)
21-
- [AstroImageJ](http://astroimagej.com/)
21+
- [Spektar Design Lab](https://spektar.io/)
2222

2323
## How to use this plugin
2424

@@ -30,7 +30,7 @@ Add the following `plugin` tag to your `pom.xml`:
3030
<plugin>
3131
<groupId>io.github.fvarrui</groupId>
3232
<artifactId>javapackager</artifactId>
33-
<version>1.7.0-SNAPSHOT</version>
33+
<version>{latest.version}</version>
3434
<executions>
3535
<execution>
3636
<phase>package</phase>
@@ -78,7 +78,7 @@ buildscript {
7878
mavenCentral()
7979
}
8080
dependencies {
81-
classpath 'io.github.fvarrui:javapackager:1.7.0-SNAPSHOT'
81+
classpath 'io.github.fvarrui:javapackager:{latest.version}'
8282
}
8383
}
8484
@@ -132,8 +132,8 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
132132
| `${name}_${version}.exe` | Setup file. | Windows | [Inno Setup](http://www.jrsoftware.org/isinfo.php) |
133133
| `${name}_${version}.msi` | MSI installer file. | Windows | [WiX Toolset](https://wixtoolset.org/) |
134134
| `${name}_${version}.msm` | MSI merge module file. | Windows | [WiX Toolset](https://wixtoolset.org/) |
135-
| `${name}_${version}.dmg` | Disk image file (uses **hdiutil**). | MacOS | |
136-
| `${name}_${version}.pkg` | PKG installer file (uses **pkgbuild**). | MacOS | |
135+
| `${name}_${version}.dmg` | Disk image file (uses **hdiutil**). | MacOS | |
136+
| `${name}_${version}.pkg` | PKG installer file (uses **pkgbuild**). | MacOS | |
137137
| `${name}-${version}-${platform}.zip` | Zipball containing generated directory `${name}`. | All | |
138138
| `${name}-${version}-${platform}.tar.gz` | Compressed tarball containing generated directory `${name}`. | All | |
139139
| `assets` | Directory with all intermediate files generated by JavaPackager. | All | |
@@ -157,7 +157,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
157157
| `customizedJre` | :x: | `true` | Generates a customized JRE, including only identified or specified modules. Otherwise, all modules will be included. |
158158
| `description` | :x: | `${project.description}` or `${displayName}` | Project description. |
159159
| `displayName` | :x: | `${project.name}` or `${name}` | App name to show. |
160-
| `envPath` | :x: | | Defines PATH environment variable in GNU/Linux and MacOS startup scripts. |
160+
| `envPath` | :x: | | Defines PATH environment variable in GNU/Linux and MacOS startup scripts. |
161161
| `extra` | :x: | | Map with extra properties to be used in customized Velocity templates, accesible through `$info.extra` variable. |
162162
| `fileAssociations` | :x: | [`FileAssociation[]`](https://github.com/fvarrui/JavaPackager/blob/master/src/main/java/io/github/fvarrui/javapackager/model/FileAssociation.java) | Associate file extensions or MIME types to the app. |
163163
| `forceInstaller` | :x: | `false` | If `true`, skips operating system check when generating installers. |
@@ -180,7 +180,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
180180
| `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. |
181181
| `scripts` | :x: | | Specify bootstrap script. **Pre and post-install scripts comming soon!** |
182182
| `url` | :x: | | App website URL. |
183-
| `useResourcesAsWorkingDir` | :x: | `true` | Uses app resources folder as default working directory (always `true` on MacOS). |
183+
| `useResourcesAsWorkingDir` | :x: | `true` | Uses app resources folder as default working directory (always `true` on MacOS). |
184184
| `version` | :x: | `${project.version}` | App version. |
185185
| `vmArgs` | :x: | `[]` | VM arguments. |
186186

@@ -191,7 +191,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
191191
| Property | Mandatory | Description |
192192
| ------------- | --------- | ------------------------------------------------------------------- |
193193
| `linuxConfig` | :x: | [GNU/Linux specific properties](docs/linux-specific-properties.md). |
194-
| `macConfig` | :x: | [MacOS specific properties](docs/macosx-specific-properties.md). |
194+
| `macConfig` | :x: | [MacOS specific properties](docs/macosx-specific-properties.md). |
195195
| `winConfig` | :x: | [Windows specific properties](docs/windows-specific-properties.md). |
196196

197197
> :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`.
@@ -294,12 +294,10 @@ Execute next commands in BASH (GNU/Linux or macOS) or CMD (Windows):
294294
1. Download source code and change to the project directory:
295295

296296
```bash
297-
git clone https://github.com/fvarrui/JavaPackager.git [--branch x]
297+
git clone https://github.com/fvarrui/JavaPackager.git [--branch devel]
298298
cd JavaPackager
299299
```
300300

301-
> where `x` is branch name (e.g. `devel`)
302-
303301
2. Compile, package and install the plugin in your local repository (ommit `./` on Windows):
304302

305303
```bash

0 commit comments

Comments
 (0)