Skip to content

Commit

Permalink
Update docs for version to 2.0.0 (pfn#29)
Browse files Browse the repository at this point in the history
* Update docs for version to 2.0.0

* Document which version of the plugin to use for sbt 0.13
  • Loading branch information
jeffboutotte authored and pfn committed Nov 12, 2019
1 parent ee7d2f6 commit 9407d0d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 12 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

Build kotlin code using sbt

Current version 1.0.9
Current version 2.0.0

## Usage

* for sbt 0.13.6+
* `addSbtPlugin("com.hanhuy.sbt" % "kotlin-plugin" % "1.0.7")`
* for sbt 1.0.0+ `addSbtPlugin("com.hanhuy.sbt" % "kotlin-plugin" % "2.0.0")`
* for sbt 0.13.x `addSbtPlugin("com.hanhuy.sbt" % "kotlin-plugin" % "1.0.9")`
* Kotlin code will build automatically from `src/XXX/kotlin`
* If necessary, add `kotlinLib("stdlib")`, it is not included by default.
* Loading standard kotlin libraries and plugins: use `kotlinLib(NAME)` as
Expand All @@ -34,7 +34,7 @@ Current version 1.0.9
* `kotlinSource`: specifies kotlin source directory, defaults to
`src/main/kotlin` and `src/test/kotlin`
* `kotlinVersion`: specifies versions of kotlin compiler and libraries to use,
defaults to `1.1.4-3`
defaults to `1.3.41`
* `kotlinLib(LIB)`: load a standard kotlin library, for example
`kotlinLib("stdlib")`; the library will utilize the version specified in
`kotlinVersion`
Expand All @@ -47,11 +47,4 @@ Current version 1.0.9

### Limitations

* kotlin compilation runs outside of the normal sbt compilation infrastructure.
As a result, sbt is unaware of classes generated during kotlin compilation.
`run` and `test` will not work automatically since kotlin classes will not
have been discovered. `runMain <main-class>` can be used in place of `run`.
`testOnly <test-class>` may be able to test individual classes/suites in
place of `test`. Any other tasks which rely on automatically detecting
classes will fail similarly.
* currently requires kotlin 1.1.4+
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name := "kotlin-plugin"

organization := "com.hanhuy.sbt"

version := "2.0.0-SNAPSHOT"
version := "2.0.0"

scalacOptions ++= Seq("-deprecation","-Xlint","-feature")
/*
Expand Down

0 comments on commit 9407d0d

Please sign in to comment.