diff --git a/README.html b/README.html index 6ca6fdf..2d3a009 100644 --- a/README.html +++ b/README.html @@ -236,6 +236,51 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf example.major=1 example.minor=0 example.patch=0 -... +# ... +
To install and run from Maven, configure an artifact as follows:
+<dependency>
+ <groupId>net.thauvin.erik</groupId>
+ <artifactId>semver</artifactId>
+ <version>0.9.1-beta</version>
+</dependency>
To install and run from Gradle, add the following to the build.gradle
file:
dependencies {
+ compile 'net.thauvin.erik:semver:0.9.1-beta'
+}
+The GeneratedVersion
class will be automatically generated in the build
directory upon compiling.
In order to also include the generated source code to your source tree, you should use the EWERK Annotation Processor Plugin. Start by addding the following to the very top of the build.gradle
file:
plugins {
+ id "com.ewerk.gradle.plugins.annotation-processor" version "1.0.2"
+}
+Then add the following to the build.gradle
file:
dependencies {
+ compile 'net.thauvin.erik:semver:0.9.1-beta'
+}
+
+annotationProcessor {
+ project.version = getVersion(isRelease)
+ library 'net.thauvin.erik:semver:0.9.1-beta'
+ processor 'net.thauvin.erik.semver.VersionProcessor'
+ // sourcesDir 'src/generated/java'
+}
+
+compileJava {
+ // Disable the classpath procesor
+ options.compilerArgs << '-proc:none'
+}
+The plugin implements a separate compile task that only runs the annotation processor and is executed during the build phase.
+Please look at the build.gradle
file in the example
module directory for a sample.
To install and run from Kobalt, add the following to the Build.kt
file:
dependencies {
+ apt("net.thauvin.erik:semver:0.9.1-beta")
+}
+Incrementing the version is best left to your favorite build system.
+For a solution using Gradle, please have a look at the build.gradle
file in the example
module directory. To run the example with patch version auto-incrementing, issue the following command:
gradle clean release run