Skip to content

Commit b5a8ef8

Browse files
committed
#192: Add BUILD.md
1 parent b6ded44 commit b5a8ef8

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

BUILD.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Build
2+
3+
The following instructions explain how to build KeepTime from sources.
4+
5+
## Prerequisites
6+
7+
* JDK with JavaFx
8+
* 17 ✅
9+
* 21 ✅
10+
* 23 ✅
11+
* 25 ❗ (Compatible for building without test)
12+
* Maven
13+
14+
Amazon Corretto JDK has JavaFx Bundled.
15+
For other JDKs you may have to install JavaFx separately.
16+
17+
The Mockito mocking library version in use for tests is not compatible with Java 25.
18+
If you trust us and you don't need to run test but you just want to build from the stable `main` branch, Java 25 is supported.
19+
20+
## Build Commands
21+
22+
Run one of the following commands from the root directory of this project, where the `pom.xml` file is found.
23+
24+
A zip file and a jar with dependencies bundled with it will be created at the `target` directory.
25+
If you don't use the profile `coverage`, crutial parts of the application will not be built.
26+
27+
### Build Without Tests
28+
29+
`mvn package -P coverage -D maven.test.skip true`
30+
31+
Only recommended on the stable `main` branch.
32+
33+
### Build With Tests
34+
35+
`mvn package -P coverage`
36+
37+
### Build With Coverage Reports
38+
39+
`mvn package org.jacoco:jacoco-maven-plugin:0.8.7:prepare-agent org.jacoco:jacoco-maven-plugin:0.8.7:report -P coverage`

0 commit comments

Comments
 (0)