Skip to content

Commit 35a2afa

Browse files
authored
Update README.md
1 parent 0ef308d commit 35a2afa

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,15 +5,15 @@
55
[![JCenter](https://img.shields.io/bintray/v/spair/io.imgui.java/lwjgl3.svg?label=lwjgl3)](https://bintray.com/spair/io.imgui.java/lwjgl3/_latestVersion)
66
[![javadoc](https://javadoc.io/badge2/io.imgui.java/binding/javadoc.svg)](https://javadoc.io/doc/io.imgui.java/binding)
77

8-
A handcrafted/generated Java binding for the [Dear-ImGui](https://github.com/ocornut/imgui) with no dependencies
8+
A handcrafted/generated Java binding for [Dear-ImGui](https://github.com/ocornut/imgui) with no dependencies
99
and ready to use pre-compiled binaries.
1010

11-
It's a straightforward binding, which uses JNI to do a direct calls to the Dear-ImGui API.<br>
11+
It's a straightforward binding, which uses JNI to do a direct calls to Dear-ImGui API.<br>
1212
Since we live in Java world - some things require to do them respectively to that fact. Please read **Binding notice**.
1313
Despite this fact, see official [documentation](https://github.com/ocornut/imgui#usage) and [wiki](https://github.com/ocornut/imgui/wiki)
1414
to get more info about how to do things in ImGui.
1515

16-
Binding doesn't force you to use backend renderer which is introduced here. Feel free to use your own renderer engine if you need so.
16+
Binding doesn't force you to use backend renderer which is introduced here. Feel free to use your own render engine if you need so.
1717
See how things are done in [ImGuiImplGl3](https://github.com/SpaiR/imgui-java/blob/v1.74-0.4/imgui-lwjgl3/src/main/java/imgui/gl3/ImGuiImplGl3.java).
1818

1919
Binding has the next version naming: `imguiVersion-bindingVersion`.<br>
@@ -33,7 +33,7 @@ gradlew :imgui-lwjgl3:startExample
3333
```
3434

3535
That's it! This will start an example app [ImGuiGlfwExample](https://github.com/SpaiR/imgui-java/blob/v1.74-0.4/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java)
36-
which relies on the GLFW and LWJGL3. Feel free to modify [ImGuiGlfwExample#showUi](https://github.com/SpaiR/imgui-java/blob/v1.74-0.4/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java#L288)
36+
which relies on GLFW and LWJGL3. Feel free to modify [ImGuiGlfwExample#showUi](https://github.com/SpaiR/imgui-java/blob/v1.74-0.4/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java#L288)
3737
method to try different ImGui widgets in action.
3838

3939
<details>
@@ -42,31 +42,31 @@ method to try different ImGui widgets in action.
4242
</details>
4343

4444
## How to use
45-
#### Step 1
45+
### Step 1
4646
Add jcenter repository:
4747
```
4848
repositories {
4949
jcenter()
5050
}
5151
```
5252

53-
#### Step 2
53+
### Step 2
5454
Add binding dependency:
5555
```
5656
implementation 'io.imgui.java:binding:1.74-0.4'
5757
```
5858

59-
#### Step 3
59+
### Step 3
6060
If you want to use LWJGL3 renderer:
6161
```
6262
implementation 'io.imgui.java:lwjgl3:1.74-0.4'
6363
```
6464
**Disclaimer!**<br>
6565
LWJGL3 renderer is based on the `3.2.3` version of the [LWJGL](https://www.lwjgl.org/).
6666
You'll need to add additional dependencies to it. Specifically `lwjgl` itself, `glfw` and `opengl` modules.
67-
You can find how to do it [here](https://www.lwjgl.org/customize).
67+
You can find how to do that [here](https://www.lwjgl.org/customize).
6868

69-
#### Step 4
69+
### Step 4
7070
Add binary lib dependency:
7171
```
7272
runtimeOnly "io.imgui.java:$imguiNatives:1.74-0.4"
@@ -86,7 +86,6 @@ VM option with path to a folder where you placed downloaded file.
8686
<details>
8787
<summary>Result build.gradle could look like this</summary>
8888

89-
```
9089
repositories {
9190
jcenter()
9291
}
@@ -96,7 +95,6 @@ VM option with path to a folder where you placed downloaded file.
9695
implementation 'io.imgui.java:lwjgl3:1.74-0.4'
9796
runtimeOnly "io.imgui.java:natives-windows:1.74-0.4"
9897
}
99-
```
10098
</details>
10199

102100
**You are ready to use imgui-java binding!**
@@ -107,11 +105,11 @@ VM option with path to a folder where you placed downloaded file.
107105
* When you need to get an input/output to/from the Dear-ImGui use primitive wrappers: `ImBool`, `ImInt` etc.
108106
* Due to the Java and JNI restrictions we can't provide a fully fledged callbacks to the ImGui::InputText*() methods.
109107
Partly you could replace some of the features (like setting of the allowed chars to input) by using the ImGuiInputTextData class.
110-
Read javadoc to get more info.
108+
Read [javadoc](https://javadoc.io/doc/io.imgui.java/binding) to get more info.
111109

112110
## How to build
113-
To build native libraries you should install mingw-w64. Then modify [GenerateLibs](https://github.com/SpaiR/imgui-java/blob/master/buildSrc/src/main/groovy/imgui/generate/GenerateLibs.groovy)
114-
to build specific binaries you need. After you configured everything run `gradlew :imgui-binding:generateLibs` task.
111+
To build native libraries you should install `mingw-w64` and `ant`. Modify [GenerateLibs](https://github.com/SpaiR/imgui-java/blob/master/buildSrc/src/main/groovy/imgui/generate/GenerateLibs.groovy)
112+
to build specific binaries you need. After everything is configure run `gradlew :imgui-binding:generateLibs` task.
115113
This will build native libraries and place them in `~/imgui-binding/build/libsNative` folder.
116114

117115
## Credits

0 commit comments

Comments
 (0)