Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add badges and How to build section to the README #27

Merged
merged 1 commit into from
Jul 3, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.