From 3cba5a944976c3e5dae703f26571b990cbda14b8 Mon Sep 17 00:00:00 2001 From: Jesper Balman Gravgaard Date: Mon, 24 Aug 2020 21:30:25 +0000 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4d09e149..eec7b7aa6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,12 +7,15 @@ facebook, or any other method with the owner of this repository before making a The prerequisites for locally building KickC are the following -* [Java JDK 8+](https://www.oracle.com/technetwork/java/javase) +* [Java OpenJDK 14+](https://www.oracle.com/technetwork/java/javase) * [Apache Maven 3+](https://maven.apache.org) -The steps to build KickC is +The steps to building KickC are 1. Download, Fork or Clone the source code from https://gitlab.com/camelot/kickc -2. Build and package the KickC compiler by entering the source directory and executing `mvn package` +2. Build and package the KickC compiler by entering the source directory and executing `mvn package` + (if you want to skip the time-consuming tests you can add the option `-DskipTests`) +3. The zipped release is placed in `target/kickc-release.zip`. You can now unzip it to a folder of your choice to start using the compiler. +