aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2015-01-11 12:18:07 +0100
committerJakob Odersky <jodersky@gmail.com>2015-01-11 12:18:07 +0100
commit78e3ef3797290afa68cc17dcc927717c3f541d20 (patch)
tree0c9a48c56a6300d7546764b363f5073737a12248 /README.md
parent3506c5643e0e7b5998eafce93b2f532b4fae9df1 (diff)
downloadakka-serial-78e3ef3797290afa68cc17dcc927717c3f541d20.tar.gz
akka-serial-78e3ef3797290afa68cc17dcc927717c3f541d20.tar.bz2
akka-serial-78e3ef3797290afa68cc17dcc927717c3f541d20.zip
update readme and changelog to newest version
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 967d04e..11fcb0a 100644
--- a/README.md
+++ b/README.md
@@ -9,13 +9,13 @@ For a short guide on how to use flow see the file [documentation/basics.md](docu
Flow is built and its examples run with SBT. To get started, include a dependency to flow in your project:
- libraryDependencies += "com.github.jodersky" %% "flow" % "2.0.8"
+ libraryDependencies += "com.github.jodersky" %% "flow" % "2.0.9"
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:
- libraryDependencies += "com.github.jodersky" % "flow-native" % "2.0.8"
+ libraryDependencies += "com.github.jodersky" % "flow-native" % "2.0.9"
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 can be supported through this solution at the same time. Currently, these are given in the table below.
@@ -33,7 +33,7 @@ ATTENTION: flow uses native libraries to back serial communication, therefore be
- Copy the native library to a place that is on the default java library path and run your application normally. Such places usually include /usr/lib and /usr/local/lib.
- Use a provided installer (currently debian archive and mac .pkg, available in releases)
- The native library can either be obtained by building flow (see section Build) or by taking a pre-compiled one, found in releases in the github project.
+ The native library can either be obtained by building flow (see section Build) or by taking a pre-compiled one, found in releases in the github project. Native libraries need to be of major version 3 to work with this version of flow.
It is recomended that you use the first option only for testing purposes or end-user applications. The second option is recomended for libraries, since it leaves more choice to the end-user.