aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2014-03-31 18:51:59 +0200
committerJakob Odersky <jodersky@gmail.com>2014-03-31 18:51:59 +0200
commitb7a5302bdf5c885db1d96c886d5c7fcdbd904b76 (patch)
treed8bd24bdc69b8579da9c5c7b013ba83a7c2981a9
parentd11381ac76016e7cdcf9e222243a3d4ccd98e45b (diff)
downloadakka-serial-b7a5302bdf5c885db1d96c886d5c7fcdbd904b76.tar.gz
akka-serial-b7a5302bdf5c885db1d96c886d5c7fcdbd904b76.tar.bz2
akka-serial-b7a5302bdf5c885db1d96c886d5c7fcdbd904b76.zip
use relative links
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5097c8a..6f9dc7d 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ Serial communication library for Scala, designed to be reactive, lightweight and
The main reason for yet another serial communication library for the JVM is that all other libraries tested used blocking IO and/or consumed enormous amounts of CPU while being idle. Flow's main goal is therefore to provide a lightweight library that only does work when communication is required. This reactive concept integrates well with the Akka IO layer therefore making flow an ideal library for extending it.
## Basic usage
-For a short guide on how to use flow see the file "documentation/basics.md", accessible on github [here](https://github.com/jodersky/flow/blob/master/documentation/basics.md).
+For a short guide on how to use flow see the file [documentation/basics.md](documentation/basics.md).
Flow is built and its examples run with SBT. To get started, include a dependency to flow in your project:
@@ -45,7 +45,7 @@ Since flow integrates into the Akka-IO framework, a good resource on its general
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.
## Build
-See detailed documentation in documentation/build.md (at github [here](https://github.com/jodersky/flow/blob/master/documentation/building.md)) on how to build flow. Note that flow can also be built on devices with sparse resources not able to run SBT (such as the Raspberry Pi), see documentation/embedded-building.md [here](https://github.com/jodersky/flow/blob/master/documentation/embedded-building.md).
+See detailed documentation in [documentation/build.md](documentation/building.md) on how to build flow. Note that flow can also be built on devices with sparse resources not able to run SBT (such as the Raspberry Pi), see [documentation/embedded-building.md](documentation/embedded-building.md).
## License
flow is released under the terms of the 3-clause BSD license. See LICENSE for details.