Skip to content

Commit

Permalink
Added installation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stefankoppier committed Jun 15, 2024
1 parent 3b06277 commit 9de462e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions website/src/posts/getting-started/posts/installation.md
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.

0 comments on commit 9de462e

Please sign in to comment.