Add MacOS specific documentation, closes #23

Author: bailuk

README.md

@@ -50,21 +50,26 @@ public class HelloWorld {
 }
 ```
 
-## Build
-`make gen`  
+## Build and run
+`./gradlew generate` or `make gen`  
 Compiles and runs the code generator. This will generate Java code from [GIR](https://gi.readthedocs.io/en/latest/) files.
+
 - Input: `generator/src/resources/gir/*`
 - Output Java: `java-gtk/build/generated/src/main/java/[...]/*.java`
 - Configuration: [generator/src/main/kotlin/ch/bailu/gtk/Configuration.kt](generator/src/main/kotlin/ch/bailu/gtk/Configuration.kt)
 
-`make`  
+`./gradlew build` or `make`  
 Creates library, javadoc and run tests
+
 - Output: jar, javadoc.jar and sources.jar in `libray/build/libs/` 
 
-`make run`  
+`./gradlew run` or `make run`  
 Run the default demo application.
 There are more demo applications in [examples/src/main/java/examples](examples/src/main/java/examples) including GeoClue2 and Adwaita samples.
 
+- To run on Windows see [doc/windows.md](doc/windows.md)
+- To run on MacOS see [doc/macos.md](doc/macos.md)
+
 `make install`  
 Compile Java library, generate JAR archive and copy JAR archive as artifact to local Maven repository (`~/.m2/repository`).
 

doc/macos.md

@@ -0,0 +1,12 @@
+# Using java-gtk on MacOS
+
+## Install GTK libraries
+
+[Setting up GTK for Mac OS ](https://www.gtk.org/docs/installations/macos/)
+
+## Running a java-gtk application
+
+On MacOS the main thread of a java-gtk application needs to be thread 0.
+In order to start the application on the correct thread the option `-XstartOnFirstThread` needs to be passed to the JVM
+
+Example: `./gradlew run -Dorg.gradle.jvmargs="-XstartOnFirstThread"`