Skip to content

Commit

Permalink
[no ci] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukebemish authored Nov 19, 2023
1 parent d909ef5 commit 59a9ecb
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,27 +37,20 @@ dependencies {

### Java

OpenSesame provides a javac plugin. Note that this will not work with eclipse's ecj compiler. To use, simply add the `opensesame-javac` dependency and specify the plugin in the compiler arguments:
OpenSesame provides a javac plugin. Note that this will not work with eclipse's ecj compiler. To use, simply add the `opensesame-javac` dependency and specify the plugin in the compiler arguments. As there is almost no reason to have the compiler
plugin present at runtime, you will likely want to split it into its runtime and compile time components:

```gradle
dependencies {
implementation 'dev.lukebemish.opensesame:opensesame-javac:<version>'
compileOnly 'dev.lukebemish.opensesame:opensesame-javac:<version>'
runtimeOnly 'dev.lukebemish.opensesame:opensesame-runtime:<version>'
}
tasks.named('compileJava', JavaCompile).configure {
options.compilerArgs.add '-Xplugin:OpenSesame'
}
```

Once again, the dependency can be split up into it's runtime and compile time components:

```gradle
dependencies {
compileOnly 'dev.lukebemish.opensesame:opensesame-javac:<version>'
runtimeOnly 'dev.lukebemish.opensesame:opensesame-runtime:<version>'
}
```

## Use

### General Use
Expand Down

0 comments on commit 59a9ecb

Please sign in to comment.