aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2016-03-05 00:31:41 -0800
committerJakob Odersky <jakob@odersky.com>2016-03-05 00:31:41 -0800
commit0629cc5837621c8bdccd7b15af00cec00586f08d (patch)
tree8eedb9870f943446f454a4e43f05c6de48d89a2f
parente69aa34a91f314ec12d4b6fec4848e81043e3d97 (diff)
downloadsbt-jni-0629cc5837621c8bdccd7b15af00cec00586f08d.tar.gz
sbt-jni-0629cc5837621c8bdccd7b15af00cec00586f08d.tar.bz2
sbt-jni-0629cc5837621c8bdccd7b15af00cec00586f08d.zip
Add build instructions to readme
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0ddd2a0..4abec53 100644
--- a/README.md
+++ b/README.md
@@ -96,5 +96,15 @@ See projects in the `samples` directory for some simple use-case examples. Note
Another, more involved example is a [serial communication library](https://jodersky.github.io/flow).
+## Building
+Both a library (`jni-library`) and an sbt plugin (`sbt-jni`) are published. Since both the plugin and user code can depend on the library, supporting multiple scala versions is not easy. Hence this project uses sbt-doge to allow cross-building on a per-project basis:
+
+- jni-library is built against scala 2.10, 2.11 and 2.12
+- sbt-jni is built against scala 2.10 (the scala version that sbt 0.13 uses)
+
+This configuration makes it necessary to always cross-compile and cross-publish this project, i.e. append a "+" before every task.
+
+Run `+publishLocal` to build and use this plugin locally.
+
## Copying
This project is released under the terms of the 3-clause BSD license. See LICENSE for details.