2019-04-01 18:18:26 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
2019-04-02 12:59:59 +00:00
|
|
|
facebook, or any other method with the owner of this repository before making a change.
|
2019-04-01 18:18:26 +00:00
|
|
|
|
2019-04-01 18:25:41 +00:00
|
|
|
## Building KickC
|
2019-04-01 18:18:26 +00:00
|
|
|
|
2019-04-02 20:12:23 +00:00
|
|
|
The prerequisites for locally building KickC are the following
|
2019-04-01 18:24:27 +00:00
|
|
|
|
2020-08-24 21:31:49 +00:00
|
|
|
* [Java 8+](https://openjdk.java.net/)
|
2019-04-02 20:12:23 +00:00
|
|
|
* [Apache Maven 3+](https://maven.apache.org)
|
2019-04-01 18:24:27 +00:00
|
|
|
|
2020-08-24 21:30:25 +00:00
|
|
|
The steps to building KickC are
|
2019-04-01 18:24:27 +00:00
|
|
|
|
|
|
|
|
1. Download, Fork or Clone the source code from https://gitlab.com/camelot/kickc
|
2020-08-24 21:32:24 +00:00
|
|
|
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`.
|
2020-08-24 21:30:25 +00:00
|
|
|
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.
|
|
|
|
|
|
2019-04-01 18:24:27 +00:00
|
|
|
|
|
|
|
|
|
