1
0
mirror of https://gitlab.com/camelot/kickc.git synced 2024-11-25 20:32:25 +00:00

Update CONTRIBUTING.md

This commit is contained in:
Jesper Balman Gravgaard 2020-08-24 21:30:25 +00:00
parent c9033b0782
commit 3cba5a9449

View File

@ -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 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) * [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 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.