README.md 3.28 KB
Newer Older
AtjonTV's avatar
AtjonTV committed
1 2
# kLib

AtjonTV's avatar
AtjonTV committed
3 4
| Branch | Status |
|--------|--------|
AtjonTV's avatar
AtjonTV committed
5
| master | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/master/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/master) |
AtjonTV's avatar
AtjonTV committed
6
| release/4.0.x | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/release/4.0.x/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/release/4.0.x) |
7
| release/4.1.x | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/release/4.0.x/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/release/4.1.x) |
AtjonTV's avatar
AtjonTV committed
8
| release/5.0.x | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/release/4.0.x/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/release/5.0.x) |
AtjonTV's avatar
AtjonTV committed
9

AtjonTV's avatar
AtjonTV committed
10
kLib is a Generic Kotlin Library to simplify development
AtjonTV's avatar
AtjonTV committed
11

AtjonTV's avatar
AtjonTV committed
12 13
Checkout the Homepage over [here](https://klib.atvg-studios.com).

AtjonTV's avatar
AtjonTV committed
14
kLib is available via the ATVG-Studios Maven repository.  
AtjonTV's avatar
AtjonTV committed
15 16
You can find the Git repository that hosts the Maven data [here](https://gitlab.atvg-studios.com/atvg-studios/maven-repository).  
The Maven Repository itself is available here: https://mvn.atvg-studios.com
AtjonTV's avatar
AtjonTV committed
17

AtjonTV's avatar
AtjonTV committed
18
Adding the latest version of kLib using Gradle:
AtjonTV's avatar
AtjonTV committed
19 20 21

```
repositories {
AtjonTV's avatar
AtjonTV committed
22
    maven { url 'https://mvn.atvg-studios.com' }
AtjonTV's avatar
AtjonTV committed
23 24 25
}

dependencies {
AtjonTV's avatar
AtjonTV committed
26
    implementation "com.atvgstudios:klib:+"
AtjonTV's avatar
AtjonTV committed
27 28 29
}
```

AtjonTV's avatar
AtjonTV committed
30
Adding the latest version of kLib using Maven:
AtjonTV's avatar
AtjonTV committed
31 32 33 34 35 36

```
<repositories>
  <repository>
    <id>atvg-studios</id>
    <name>ATVG-Studios Maven</name>
AtjonTV's avatar
AtjonTV committed
37
    <url>https://mvn.atvg-studios.com</url>
AtjonTV's avatar
AtjonTV committed
38 39 40 41 42 43
  </repository>
</repositories>
<dependencies>
  <dependency>
    <groupId>com.atvgstudios</groupId>
    <artifactId>klib</artifactId>
AtjonTV's avatar
AtjonTV committed
44
    <version>[0.1.0,)</version>
AtjonTV's avatar
AtjonTV committed
45 46 47 48
  </dependency>
</dependencies>
```

AtjonTV's avatar
AtjonTV committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
# 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)

AtjonTV's avatar
AtjonTV committed
80 81 82 83 84 85
# 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.

Please read the [CONTRIBUTION GUIDE](CONTRIBUTING.md) before doing any dedicated development.

AtjonTV's avatar
AtjonTV committed
86 87 88 89 90 91
# Version Compatibility

Checkout our doc about [Compatibility](Compatibility.md).  
It contains information about which versions are compatible without issues.  
Also what breaking changes where made when and which will come up in near future!

AtjonTV's avatar
AtjonTV committed
92 93
## Outdated Versions

AtjonTV's avatar
AtjonTV committed
94 95 96 97 98 99 100 101
All listed versions are considered Legacy and are no longer developed or supported.

| Version Tree | Last Version |
|--------------|--------------|
|    0.1.x     |    0.1.6     |
|    0.2.x     |    0.2.2     |
|    1.x.x     |    1.4.0     |
|    2.x.x     |    2.1.1     |
AtjonTV's avatar
AtjonTV committed
102
|    3.x.x     |    3.2.0     |
AtjonTV's avatar
AtjonTV committed
103

AtjonTV's avatar
AtjonTV committed
104 105
# License

AtjonTV's avatar
AtjonTV committed
106
kLib is distributed under the [OSPL 20](LICENSE) License (a MPL 2.0 Fork).