Skip to content

Commit 6ffdb08

Browse files
committed
Update documentation
1 parent e95c544 commit 6ffdb08

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
GTK 4 bindings for Java.
77
It uses [Java Native Access (JNA)](https://github.com/java-native-access/jna) to access GTK libraries.
88

9-
[![POC screenshot](screenshot.png)](examples/src/main/java/examples/ImageBridge.java)
9+
[![POC screenshot](doc/screenshot.png)](examples/src/main/java/examples/ImageBridge.java)
1010

1111
## Example
1212

doc/overview.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<p>
66
<ul>
77
<li><a href="https://github.com/bailuk/java-gtk">GitHub source repository</a></li>
8-
<li><a href="https://github.com/bailuk/java-gtk/doc/concepts.md">Concepts of java-gtk</a></li>
9-
<li><a href="https://github.com/bailuk/java-gtk/doc/windows.md">Using java-gtk on Windows</a></li>
8+
<li><a href="https://github.com/bailuk/java-gtk/blob/main/doc/concepts.md">Concepts of java-gtk</a></li>
9+
<li><a href="https://github.com/bailuk/java-gtk/blob/main/doc/windows.md">Using java-gtk on Windows</a></li>
1010
</ul>
1111
</BODY>
1212
</HTML>
File renamed without changes.

doc/windows.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Install GTK libraries
1+
# Using java-gtk on Windows
2+
3+
## Install GTK libraries
24

35
See [Setting up GTK for Windows](https://www.gtk.org/docs/installations/windows)
46

@@ -11,7 +13,7 @@ pacman -S mingw-w64-x86_64-libadwaita
1113
3. Add `C:\msys64\mingw64\bin` to PATH
1214

1315

14-
# Build and run sample
16+
## Build and run sample
1517

1618
```PowerShell
1719
git clone https://github.com/bailuk/java-gtk.git
@@ -21,17 +23,17 @@ cd java-gtk
2123
.\gradlew.bat run
2224
```
2325

24-
# Trouble shoot
26+
## Trouble shoot
2527

26-
## Alternative names
28+
### Alternative names
2729

2830
GTK for Windows has a different naming schema for libraries than assumed by default.
2931
Default library names are configured in [Configuration.kt](../generator/src/main/kotlin/ch/bailu/gtk/Configuration.kt).
3032
Alternative names are configured in [loader.properties](../java-gtk/src/main/resources/jna/loader.properties).
3133
More alternative names can be added programmatically during runtime: [Loader.java](../java-gtk/src/main/java/ch/bailu/gtk/lib/jna/Loader.java).
3234

3335

34-
## Windows library load order
36+
### Windows library load order
3537

3638
Windows library (dll) search paths:
3739
- Current directory
@@ -40,29 +42,29 @@ Windows library (dll) search paths:
4042
- Windows PATH variable
4143

4244

43-
## Related and useful system properties (Java and JNA)
45+
### Related and useful system properties (Java and JNA)
4446

4547
```Java
4648
System.setProperty("jna.debug_load", "true");
4749
System.out.println(System.getProperty("java.library.path"));
4850
System.out.println(System.getProperty("jna.library.path"));
4951
```
5052

51-
## JNA library load order
53+
### JNA library load order
5254

5355
1. `java.library.path`
5456
2. `jna.library.path`
5557
3. Resource path: JAR or `build\classes\java\main`
5658

57-
## Dependencies
59+
### Dependencies
5860

5961
DLLs depend on other DLLs. In this case linking is done by the Windows OS and not by JNA.
6062
To check dependencies, run ldd from WinGW Terminal: `ldd library-to-check.dll`
6163

6264
DLLs loaded by JNA must be identical (same file, not a copy) with DLLs loaded by Windows.
6365

6466

65-
## Naming
67+
### Naming
6668

6769
lib[name]-[major]-[minor].dll
6870

0 commit comments

Comments
 (0)