diff --git a/HACKING.adoc b/HACKING.adoc new file mode 100644 index 0000000..e566037 --- /dev/null +++ b/HACKING.adoc @@ -0,0 +1,23 @@ +=== Hacking Verspätung + +Verspätung is a link:http://groovy-lang.org[Groovy]-based application which is +built with link:http://gradle.org[Gradle]. As such, if you are already familiar +with these tools you should be able to find your way around the project with +relative ease. + + +A quick primer on what tasks are available: + +* Running tests: `./gradlew check` +* Running the app locally: `./gradlew run -PzookeeperHosts=localhost:2181` +* Building the app for distribution: `./gradlew assemble` + + +=== Releasing Verspätung + +NOTE: This is mostly meant for the developer team. + +Currently releases can be produced by simply pushing a Git tag to this GitHub +repository. This will cause Travis CI to build and test the tag, which if it is +successful, will automatically publish to +link:https://bintray.com/lookout/systems/verspaetung[Bintray]. diff --git a/README.adoc b/README.adoc index 817e873..6fbff0f 100644 --- a/README.adoc +++ b/README.adoc @@ -29,16 +29,3 @@ Running Verspätung is rather easy, by default the daemon will monitor the standard Kafka high-level consumer offset path of `/consumers` and start reporting deltas automatically. -=== Hacking - -* Running tests: `./gradlew check` -* Running the app locally: `./gradlew run -PzookeeperHosts=localhost:2181` -* Building the app for distribution: `./gradlew assemble` - - -=== Releasing - -This is mostly meant for the developer team, but currently releases can be -produced by simply pushing a Git tag to this GitHub repository. This will cause -Travis CI to build and test the tag, which if it is successful, will -automatically publish to link:https://bintray.com/lookout/systems/verspaetung[Bintray]. diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index fc3fd09..3cfe1ba 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -1,6 +1,15 @@ = Verspätung :toc: right -== README + +== Overview/Readme include::../../../README.adoc[] + +== Developing + +=== Useful links + +* link:groovydoc/[Internal API docs] + +include::../../../HACKING.adoc[]