Skip to content

Commit

Permalink
Merge pull request #56 from DavidGregory084/usage-instructions
Browse files Browse the repository at this point in the history
Expand usage instructions
  • Loading branch information
DavidGregory084 authored Mar 30, 2022
2 parents 001c57c + a5d1b50 commit e7b634b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Add the following to your project's `project/plugins.sbt`:
addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat" % "0.2.0")
```

Once you are using this plugin we recommend that you don't manipulate the `scalacOptions` key directly.

Instead you should modify the `tpolecatScalacOptions` key or the options key for the relevant mode, for example `tpolecatDevModeOptions` for the development mode.

### Configuring the REPL

To filter out scala compiler options that don't work well in the REPL, use the `tpolecatConsoleOptionsFilter`.

By default the plugin only applies this filter to the `console` task in the `Compile` and `Test` configurations.
Expand Down

0 comments on commit e7b634b

Please sign in to comment.