Verified Commit 734426df authored by AtjonTV's avatar AtjonTV

Readme: Guide for compiling

parent c2b03f77
...@@ -45,6 +45,37 @@ Adding the latest version of kLib using Maven: ...@@ -45,6 +45,37 @@ Adding the latest version of kLib using Maven:
</dependencies> </dependencies>
``` ```
# Compiling
To compile kLib yourself, first off clone the repository.
Go into the kLib folder, now you have two ways to compile:
###### Compile with Make (*nix Only)
This is the simplest way, just run:
```
$ make
```
Uses: gradlew
Runs: ktlint, gradle tasks: build shadowjar jar sourcejar dokka
###### Compile manually with gradlew
Manually run the Gradle tasks.
(**Windows**: Use `./gradlew.bat` when using Powershell | Use `.\gradlew.bat` when using CMD)
```
$ ./gradlew build shadowjar
```
### Known Compiler Warnings
* [Property 'dokkaRuntime' is not annotated with an input or output annotation](https://github.com/Kotlin/dokka/issues/515)
# Contributing # Contributing
If you want to contribute, please add your name, email, company (if any) and homepage (if any) to the Authors Array in the kLibInfo. If you want to contribute, please add your name, email, company (if any) and homepage (if any) to the Authors Array in the kLibInfo.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment