aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2014-12-21 21:14:29 +0100
committerJakob Odersky <jodersky@gmail.com>2014-12-21 21:14:34 +0100
commit73b02481d2df2db5b6c2c6e56706fd93bdf806d3 (patch)
tree6b4e01efc681ba4af2b1019d7f207c756f368058 /README.md
parent0ecb38d32f6881772fda28cb59a0d68776a517d0 (diff)
downloadakka-serial-73b02481d2df2db5b6c2c6e56706fd93bdf806d3.tar.gz
akka-serial-73b02481d2df2db5b6c2c6e56706fd93bdf806d3.tar.bz2
akka-serial-73b02481d2df2db5b6c2c6e56706fd93bdf806d3.zip
minor version upgradesv2.0.8
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 bd76625..967d04e 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.6"
+ libraryDependencies += "com.github.jodersky" %% "flow" % "2.0.8"
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.6"
+ libraryDependencies += "com.github.jodersky" % "flow-native" % "2.0.8"
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.
@@ -40,7 +40,7 @@ It is recomended that you use the first option only for testing purposes or end-
## Examples
Examples on flow's usage are located in the flow-samples directory. The examples may be run by switching to the corresponding project in sbt: `project flow-samples-<sample_name>` and typing `run`. Be sure to connect a serial device before running an example.
-Since flow integrates into the Akka-IO framework, a good resource on its general design is the framework's documentation at http://doc.akka.io/docs/akka/2.3.2/scala/io.html
+Since flow integrates into the Akka-IO framework, a good resource on its general design is the framework's documentation at http://doc.akka.io/docs/akka/2.3.8/scala/io.html
## Native side
Since hardware is involved in serial communication, a Scala-only solution is not possible. Nevertherless, the native code is kept simple and minimalistic with the burden of dealing with threads left to Scala. The code aims to be POSIX compliant and therefore easily portable.