Skip to content

Commit 67b23dd

Browse files
authored
[Doc] Update README about automatic module names
1 parent 3cd0eeb commit 67b23dd

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Feel free to add other platforms.
138138
|----------------------------|---------|
139139
| imgui-java-natives-windows | Windows |
140140
| imgui-java-natives-linux | Linux |
141-
| imgui-java-natives-macos | MacOS |
141+
| imgui-java-natives-macos | macOS |
142142

143143
Take a note, that you also need to add dependencies to [LWJGL](https://www.lwjgl.org/). Examples below shows how to do it as well.
144144

@@ -247,20 +247,22 @@ dependencies {
247247
2. Download `imgui-binding-${version}.jar`, `imgui-lwjgl3-${version}.jar` and binary libraries for your OS;
248248
- imgui-java64.dll - Windows
249249
- libimgui-java64.so - Linux
250-
- libimgui-java64.dylib - MacOS
250+
- libimgui-java64.dylib - macOS
251251
3. Add jars to your classpath;
252252
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.
253253
</details>
254254

255255
#### Java Module System
256256
If using Java 9 modules, imgui-java has Automatic Module Names:
257257

258-
| Package | Module |
259-
|--------------------|---------------|
260-
| imgui-java-app | imgui.app |
261-
| imgui-java-binding | imgui.binding |
262-
| imgui-java-lwjgl3 | imgui.lwjgl3 |
263-
| imgui-java-natives | imgui.natives |
258+
| Package | Module |
259+
|----------------------------|-----------------------|
260+
| imgui-java-app | imgui.app |
261+
| imgui-java-binding | imgui.binding |
262+
| imgui-java-lwjgl3 | imgui.lwjgl3 |
263+
| imgui-java-natives-windows | imgui.natives.windows |
264+
| imgui-java-natives-linux | imgui.natives.linux |
265+
| imgui-java-natives-macos | imgui.natives.macos |
264266

265267
## Extensions
266268
- [ImNodes](https://github.com/Nelarius/imnodes/tree/857cc860af05ac0f6a4039c2af33d982377b6cf4) | [Example](https://github.com/SpaiR/imgui-java/blob/v1.86.3/example/src/main/java/ExampleImNodes.java) <br>
@@ -332,7 +334,7 @@ Don't forget to make clear for your Linux/Mac users, that they will need to inst
332334
|-------------------------------|---------|
333335
| imgui-java-natives-windows-ft | Windows |
334336
| imgui-java-natives-linux-ft | Linux |
335-
| imgui-java-natives-macos-ft | MacOS |
337+
| imgui-java-natives-macos-ft | macOS |
336338
337339
# Binding Notice
338340
Binding was made with java usage in mind. Some places of the original library were adapted for that.<br>
@@ -362,7 +364,7 @@ Ensure you've downloaded git submodules. That could be achieved:
362364
- Build with: `./gradlew :imgui-binding:generateLibs -Denvs=linux -Dlocal`
363365
- Run with: `./gradlew :example:run -PlibPath=../imgui-binding/build/libsNative/linux64`
364366
365-
### MacOS
367+
### macOS
366368
- Check dependencies from "Linux" section and make sure you have them installed.
367369
- Build with: `./gradlew :imgui-binding:generateLibs -Denvs=mac -Dlocal`
368370
- Run with: `./gradlew :example:run -PlibPath=../imgui-binding/build/libsNative/macosx64`
@@ -372,9 +374,9 @@ In `envs` parameter next values could be used `win`, `linux` or `mac`.<br>
372374
On Windows always use local build.
373375
374376
# Support
375-
You can support the project to motivate its further development.
376-
377377
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P5BF17Q)
378378
379+
You can support the project to motivate its further development.
380+
379381
# License
380382
See the LICENSE file for license rights and limitations (Apache-2.0).

0 commit comments

Comments
 (0)