Skip to content

Commit c9a9714

Browse files
committed
Update README.md
1 parent 528eba1 commit c9a9714

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ task packageMyApp(type: io.github.fvarrui.javapackager.gradle.PackageTask, depen
108108
}
109109
```
110110

111-
> See [Gradle plugin configuration samples](docs/gradle/plugin-configuration-samples.md) to know more.
111+
> [!TIP]
112+
> See [Gradle plugin configuration samples](docs/gradle/plugin-configuration-samples.md) to know more.
112113
113114
And execute the next command in project's root folder:
114115

@@ -136,6 +137,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
136137
| `${name}-${version}-${platform}.tar.gz` | Compressed tarball containing generated directory `${name}`. | All | |
137138
| `assets` | Directory with all intermediate files generated by JavaPackager. | All | |
138139

140+
> [!TIP]
139141
> **Inno Setup** and **WiX Toolset** installation [guide](docs/windows-tools-guide.md).
140142
141143
### Plugin configuration properties
@@ -183,6 +185,7 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
183185
| `version` | :x: | `${project.version}` | App version. |
184186
| `vmArgs` | :x: | `[]` | VM arguments. |
185187

188+
> [!IMPORTANT]
186189
> Some default values depends on the used building tool.
187190
188191
**Platform specific properties**
@@ -193,7 +196,8 @@ By default it will generate next artifacts in `${outputDirectory} ` folder:
193196
| `macConfig` | :x: | [MacOS specific properties](docs/macosx-specific-properties.md). |
194197
| `winConfig` | :x: | [Windows specific properties](docs/windows-specific-properties.md). |
195198

196-
> :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`.
199+
> [!WARNING]
200+
> 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`.
197201
198202
### Plugin assets
199203

@@ -220,7 +224,8 @@ ${assetsDir}/
220224
└── ${name}.ico # on Windows it has to be a ICO file
221225
```
222226

223-
> :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.
227+
> [!WARNING]
228+
> 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.
224229
225230
#### Templates
226231

@@ -380,6 +385,7 @@ cd JavaPackager
380385
./gradlew publishToMavenLocal
381386
```
382387

388+
> [!IMPORTANT]
383389
> It is recommended to build the plugin with Java 19.
384390
385391
## How to release the plugin to Maven Central

0 commit comments

Comments
 (0)