Skip to content

Commit 88f98d8

Browse files
committed
[Doc] Tweak readme about release page files
1 parent 87b1004 commit 88f98d8

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Read `imgui.app.Application` [javadoc](https://javadoc.io/doc/io.github.spair/im
110110

111111
### Dependencies
112112

113-
![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/imgui-java-binding?color=green&label=Version%20to%20use&style=flat-square)
113+
![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/imgui-java-binding?color=green&label=Version:&style=flat-square)
114114

115115
<details>
116116
<summary><b>Gradle</b></summary>
@@ -144,8 +144,15 @@ dependencies {
144144
<summary><b>Raw Jar</b></summary>
145145

146146
1. Go to the [release page](https://github.com/SpaiR/imgui-java/releases/latest);
147-
2. Download `imgui-app-${version}.jar`;
148-
3. Add the jar to your classpath.
147+
2. Download `java-libraries.zip`;
148+
3. Get `imgui-app-${version}-all.jar`;
149+
4. Add the jar to your classpath.
150+
151+
Jar with `all` classifier already contains `binding` and `lwjgl3` modules.<br>
152+
If you're using jar without the `all` classifier, add appropriate jars as well.
153+
154+
Both jars, with or without `all` classifier, have all required native libraries already.
155+
149156
</details>
150157

151158
#### Java Module System
@@ -159,7 +166,7 @@ You can refer to `imgui-app` module to see how things are done there.
159166

160167
### Dependencies
161168

162-
![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/imgui-java-binding?color=green&label=Version%20to%20use&style=flat-square)
169+
![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/imgui-java-binding?color=green&label=Version:&style=flat-square)
163170

164171
For simplicity, example of dependencies for Gradle / Maven only shows how to add natives for Windows. Feel free to add other platforms.
165172

@@ -272,13 +279,18 @@ dependencies {
272279
<details>
273280
<summary><b>Raw Jars</b></summary>
274281

275-
1. Go to the [release page](https://github.com/SpaiR/imgui-java/releases/latest);
276-
2. Download `imgui-binding-${version}.jar`, `imgui-lwjgl3-${version}.jar` and binary libraries for your OS;
277-
- imgui-java64.dll - Windows
278-
- libimgui-java64.so - Linux
279-
- libimgui-java64.dylib - macOS
280-
3. Add jars to your classpath;
281-
4. Provide a VM option: `imgui.library.path` or `java.library.path`. It should point to the folder where you've placed downloaded native libraries.
282+
1. Go to the [release page](https://github.com/SpaiR/imgui-java/releases/latest);
283+
2. Download `java-libraries.zip` and `native-libraries.zip` (`native-libraries-with-freetype.zip` for FreeType font rendering);
284+
3. Get `imgui-binding-${version}.jar` and `imgui-lwjgl3-${version}.jar` from `java-libraries`, and binary libraries for required OS from `native-libraries` archive;
285+
4. Add jars to your classpath;
286+
5. Provide a VM option with location of files from the `native-libraries` (or `native-libraries-with-freetype`) archive.
287+
288+
VM option example:
289+
- **-Dimgui.library.path=_${path}_**
290+
- **-Djava.library.path=_${path}_**
291+
292+
Both `imgui.library.path` and `java.library.path` are equal with the difference, that `java.library.path` is standard JVM option to provide native libraries.
293+
282294
</details>
283295

284296
#### Java Module System
@@ -335,7 +347,7 @@ Don't forget to make clear for your Linux/Mac users, that they will need to inst
335347

336348
### Dependencies
337349

338-
![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/imgui-java-binding?color=green&label=Version%20to%20use&style=flat-square)
350+
![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/imgui-java-binding?color=green&label=Version:&style=flat-square)
339351

340352
Use the same native libraries as you would, but with `-ft` suffix in the end.
341353

@@ -375,7 +387,7 @@ Use the same native libraries as you would, but with `-ft` suffix in the end.
375387
| imgui-java-natives-linux-ft | Linux |
376388
| imgui-java-natives-macos-ft | macOS |
377389

378-
If you're using raw dll/so files, go to the `bin/freetype` folder and take them from there.
390+
If you're using raw dll/so files, go to the [release page](https://github.com/SpaiR/imgui-java/releases/latest) and use libraries from the `native-libraries-with-freetype.zip` archive.
379391

380392
# Binding Notice
381393

0 commit comments

Comments
 (0)