This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/master by this push: new e7a5007 Add badges and How to build section to the README new 1851223 Merge pull request #27 from ppalaga/190702-readme e7a5007 is described below commit e7a50071ffcdf93115d52b4b9b8237a8fe8c3138 Author: Peter Palaga <ppal...@redhat.com> AuthorDate: Sun Jun 30 20:02:50 2019 +0200 Add badges and How to build section to the README --- README.adoc | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.adoc b/README.adoc index 481383c..c833b99 100644 --- a/README.adoc +++ b/README.adoc @@ -1,5 +1,11 @@ = Apache Camel extensions for Quarkus +image:https://img.shields.io/maven-central/v/org.apache.camel.quarkus/camel-quarkus-bom.svg["Maven Central", link="http://search.maven.org/#search%7Cga%7C1%7Corg.apache.camel.quarkus"] +image:https://img.shields.io/travis/apache/camel-quarkus/master.svg?logo=travis&color=white&label=Travis+CI["Travis CI build status", link="http://travis-ci.org/apache/camel-quarkus"] +image:https://img.shields.io/github/license/openshift/origin.svg?maxAge=2592000["Licensed under Apache License version 2.0", link="https://www.apache.org/licenses/LICENSE-2.0"] +image:https://badges.gitter.im/apache/camel-quarkus.svg["Chat on Gitter", link="https://gitter.im/apache/camel-quarkus"] + + == What is this This project hosts the efforts to port and package the 280+ Camel components as Quarkus extensions. @@ -14,6 +20,39 @@ https://quarkus.io/extensions/[Quarkus extensions] are units of Quarkus distribu a technology (in our case Camel components) into your Quarkus application. You will typically use them as dependencies in your project. + +== How to build + +Prerequisites: + +* Java 8 +* Maven 3.5.4+ or you can use the provided Maven Wrapper, a.k.a. `mvnw` +* GraalVM +** Check link:.travis.yml[.travis.yml] for the version and steps to install +** Set the `GRAALVM_HOME` environment variable to point at the root directory of your GraalVM installation + +Fast build without tests: + +[source,shell] +---- +./mvnw clean install -DskipTests +---- + +Build with tests only in JVM mode: + +[source,shell] +---- +./mvnw clean install +---- + +Build with tests in JVM mode and native mode: + +[source,shell] +---- +./mvnw clean install -Dnative -Dnative-image.xmx=5g +---- + + == Licensing This software is licensed under the terms you may find in the file named `LICENSE.txt` in this directory.