aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2013-06-19 17:22:42 +0200
committerJakob Odersky <jodersky@gmail.com>2013-06-19 17:22:42 +0200
commit9965d8e7352de8bee514109f9af2c2a1a48bff11 (patch)
tree768847329e4f209b43e7b22c971cf0e6a4f70583 /README.md
parent05ae5ad725d7577b64444eebfe304d0637df216b (diff)
downloadakka-serial-9965d8e7352de8bee514109f9af2c2a1a48bff11.tar.gz
akka-serial-9965d8e7352de8bee514109f9af2c2a1a48bff11.tar.bz2
akka-serial-9965d8e7352de8bee514109f9af2c2a1a48bff11.zip
update readme to new version
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/README.md b/README.md
index 7efb416..761ae2e 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,15 @@
# flow
-Serial communication library for Scala, designed to be reactive, lightweight and easy-to-use.
+Serial communication library for Scala, designed to be reactive, lightweight and easily integrable with Akka-IO.
-## Yet another library?
-The main reason for yet another serial communication library for the JVM is that all other libraries I tested used blocking IO and ate up enormous amounts of CPU while being idle, between 2% and 15%. Believing that if there is no work to be done, then no work should be done, I went to write flow.
-
-Flow's aim is to provide a reactive serial library easily useable with Scala futures and Akka actors.
+## Motivation
+The main reason for yet another serial communication library for the JVM is that all other libraries I tested used blocking IO and consumed enormous amounts of CPU while being idle, between 2% and 15%. Flow's main goal is therefore to provide a lightweight library that only does work when communication is required. This concept integrates well with the Akka IO layer therefore making flow an ideal candidate for extending it.
## Native side
-Since hardware is involved for serial communication, a Scala-only solution is not possible. Nevertherless, the native code is kept simple and minimalistic with the implementation of non-blocking IO left mainly to Scala. Currently the native version has only been tested with Linux, however the code should be POSIX compliant and therefore easily portable.
+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 implementation of non-blocking IO left mainly to Scala. Currently the native version has only been tested with Linux, however the code should be POSIX compliant and therefore easily portable.
## Build & usage
Run sbt in the root directory and switch to project 'flow', by typing 'project flow'. Running 'package' will compile both Scala and native sources and bundle them in the standard jar file. When using the jar in another application, the native library will be automatically extracted and loaded (i.e. no -Djava.library.path or other system parameters have to be set).
-To see an example, switch to project 'flow-example', by typing 'project flow-example' and then type 'run'. Don't forget to connect a serial device (such as an arduino) before runinng the example.
+To see an example, switch to project 'flow-samples' and then type 'run'. Don't forget to connect a serial device (such as an arduino) before runinng the example.
The build currently only works on Linux.