diff options
author | Erik De Rijcke <derijcke.erik@gmail.com> | 2015-02-11 21:01:33 +0100 |
---|---|---|
committer | Erik De Rijcke <derijcke.erik@gmail.com> | 2015-02-11 21:01:33 +0100 |
commit | b246ba0e3eb46d9f303cd86134f6aff0b9ab6a28 (patch) | |
tree | 1a9c8402f5225fcb06a2ba2a0635eeb190b0e1be | |
parent | b0b357b14d00c900c6c9392ebf645a5c6b6b3758 (diff) |
change readme to reflect maven build system
-rw-r--r-- | README.md | 39 |
1 files changed, 32 insertions, 7 deletions
@@ -7,24 +7,49 @@ Javadoc ======= [Here](http://zubnix.github.io/wayland-java-bindings/) -Usage -==================== -Run `gradle install` in the root of the project and add the maven dependency +Using +===== +Bindings are available in the maven central repository: +```xml + <dependency> + <groupId>org.freedesktop</groupId> + <artifactId>wayland</artifactId> + <version>1.1.1</version> + </dependency> +``` + +Building +======== +Run `mvn install` in the root of the project and add the following +maven dependency to start using the bindings: ```xml <dependency> <groupId>org.freedesktop</groupId> <artifactId>wayland</artifactId> - <version>1.1.0</version> + <version>1.2.0-SNAPSHOT</version> </dependency> ``` Private protocol ================ The project allows you to generate your own private wayland protocol bindings. - - Add `org.freedesktop:generator:1.1.0` to your build path, no need to put it on your classpath as it will only be used during compilation. - - Add `org.freedesktop:stubs:1.1.0` to your classpath. + - Add ```xml + <dependency> + <groupId>org.freedesktop</groupId> + <artifactId>generator</artifactId> + <version>1.1.1</version> + <scope>provided</scope> + </dependency> + ``` to your build path, no need to put it on your classpath as it will only be used during compilation. + - Add ```xml + <dependency> + <groupId>org.freedesktop</groupId> + <artifactId>stubs</artifactId> + <version>1.1.1</version> + </dependency> + ``` to your classpath. - Add a `@Protocols` annotation to your own private `package-info.java` file and set it to use your own private protocol xml file. Here's an [example](wayland/src/main/java/org/freedesktop/wayland/package-info.java). - - Build with maven or gradle. The generated bindings should automatically appear in the same package as your `package-info.java` file. + - Build your project with maven (or gradle). The generated bindings should automatically appear in the same package as your `package-info.java` file. State ===== |