1
0
mirror of https://gitlab.com/camelot/kickc.git synced 2024-12-24 04:31:02 +00:00
kickc/CONTRIBUTING.md
Jesper Balman Gravgaard 17b6ea8980 Update CONTRIBUTING.md
2020-08-24 21:32:24 +00:00

22 lines
825 B
Markdown

# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
facebook, or any other method with the owner of this repository before making a change.
## Building KickC
The prerequisites for locally building KickC are the following
* [Java 8+](https://openjdk.java.net/)
* [Apache Maven 3+](https://maven.apache.org)
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`.
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.