diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 4 insertions, 2 deletions
@@ -13,10 +13,12 @@ Flow is built and its examples run with SBT. To get started, include a dependenc ATTENTION: flow uses native libraries to back serial communication, therefore before you can run any application depending on flow you must include flow's native library! To do so, you have two options. -1. The easy way: add a second dependency to your project: (this dependency is not available on maven, please run ```flow-pack/publishLocal``` before) +1. The easy way: add a second dependency to your project: libraryDependencies += "com.github.jodersky" %% "flow-pack" % "1.2.1" - + + Note that this dependency is not available on maven and has to be published locally, run ```sbt flow-pack/publishLocal -Drelease=true``` before. + This will add a jar to your classpath containing native libraries for various platforms. At run time, the correct library for the current platform is selected, extracted and loaded. This solution enables running applications seamlessly, as if they were pure JVM applications. However, since the JVM does not enable full determination of the current platform (only OS and rough architecture are known), only a couple of platforms are supported through this solution. Currently, these are given in the table below. | OS | Architecture | Notes | |