Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
winter-yuki committed Feb 15, 2022
1 parent a69be03 commit 4f39b58
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ Kotlin compiler plugin that adds `shallowSize` extension property to all data cl

## Getting started

### Usage

Kotlin 1.5.0 is supported.

1. Download `.jar` from release assets.
2. Add compiler option in `build.gradle.kts`:

```kotlin
kotlinOptions {
freeCompilerArgs = listOf(
"-Xplugin=/path/to/core-1.0-SNAPSHOT.jar",
"-P",
"plugin:arrow.meta.plugin.compiler:generatedSrcOutputDir=${buildDir}"
)
}
```

### Development

```bash
Expand Down

0 comments on commit 4f39b58

Please sign in to comment.