Skip to content

Commit a7f92b2

Browse files
committed
Add readme
1 parent adecbbd commit a7f92b2

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# imgui-java
2+
A handcrafted 1-1 Java binding for [Dear-ImGui](https://github.com/ocornut/imgui).
3+
4+
*Some of the very specific features are still in a wip state.*
5+
6+
### How to use
7+
TBA
8+
9+
##### Specifics of usage
10+
* Since it's a 1-1 binding please consider to see official [documentation](https://github.com/ocornut/imgui#usage) and [wiki](https://github.com/ocornut/imgui/wiki) to get more info about how to do things.
11+
* In places where in C++ you need to pass `ImVec2` or `ImVec4`, you'll need to pass two or four float parameters respectively.
12+
* When you need to get an output from the Dear-ImGui use wrappers for primitives: `ImBool`, `ImInt` etc.
13+
14+
### How to build
15+
TBA
16+
17+
### Credits
18+
This binding is based on the work of [xpenatan](https://github.com/xpenatan) and his version of the binding [jDear-imgui](https://github.com/xpenatan/jDear-imgui).
19+
20+
### License
21+
See the LICENSE file for license rights and limitations (Apache-2.0).

0 commit comments

Comments
 (0)