-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3b06277
commit 9de462e
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: "Installation" | ||
summary: "" | ||
eleventyNavigation: | ||
key: Installation | ||
parent: Getting Started | ||
order: 2 | ||
--- | ||
|
||
Mappie is a Kotlin compiler plugin. The most convenient way to use compiler plugins is | ||
to apply the Gradle plugin which in term applies the compiler plugin to the Kotlin compilation. | ||
|
||
This can be achieved by adding the following snippet to the `build.gradle.kts` file. | ||
```kotlin | ||
plugins { | ||
id("io.github.mappie") version "x.y.z" | ||
} | ||
``` | ||
The `mappie-api` dependency must be added to the `build.gradle.kts` file for the programming interface | ||
```kotlin | ||
dependencies { | ||
implementation("io.github.mappie:mappie-api:x.y.z") | ||
} | ||
``` | ||
The most recent version of Mappie can be found at the [releases](https://github.com/Mr-Mappie/mappie/releases) page. |