Commit 57a15cbe authored by Yuri Blankenstein's avatar Yuri Blankenstein
Browse files

#10 Add note about using Java8 to developer guide

parent cf8cdaed
Pipeline #5091 failed with stage
in 0 seconds
......@@ -14,18 +14,27 @@ include::_attributes.asciidoc[]
include::dev-env-setup.asciidoc[]
[[maven-build]]
== Building with Maven
[CAUTION]
====
{trace} should be built using a _Java 1.8 VM_.
The JDK can be downloaded from e.g. https://www.oracle.com/technetwork/pt/java/javase/downloads/jdk8-downloads-2133151.html[Oracle] or https://adoptium.net/archive.html?variant=openjdk8&jvmVariant=hotspot[Adoptium]. +
To test which Java version is used by Maven, type `mvn -version` in a command shell.
====
To build {trace} with Maven execute the following command in the root:
Linux :: `./build.sh`
Windows :: `.\build.cmd`
Other :: `mvn -Dtycho.pomless.aggregator.names=releng,temporallogic,trace,jfreechart`
NOTE: In the remainder of this document this command will be referred to as `build.sh`
== License header
The Maven build uses https://github.com/mycila/license-maven-plugin[license-maven-plugin] to determine if the link:../releng/legal-defaults/license-header.txt[correct license headers] are used for source files.
The <<maven-build, Maven build>> uses https://github.com/mycila/license-maven-plugin[license-maven-plugin] to determine if the link:../releng/legal-defaults/license-header.txt[correct license headers] are used for source files.
If the header is incorrect the build fails.
Handy commands:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment