aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2016-05-16 15:28:59 -0700
committerJakob Odersky <jakob@odersky.com>2016-06-09 03:30:35 -0700
commit92c4b3d41e06ad4b89004212c85248e9e6cd61d7 (patch)
tree69470f7c4ed48edaebea91964d7d552e7eaacf0d /README.md
parentf6f26c2c9e3ec9bdd45fb384483b3450bef5984a (diff)
downloadakka-serial-92c4b3d41e06ad4b89004212c85248e9e6cd61d7.tar.gz
akka-serial-92c4b3d41e06ad4b89004212c85248e9e6cd61d7.tar.bz2
akka-serial-92c4b3d41e06ad4b89004212c85248e9e6cd61d7.zip
Move project to `ch.jodersky` and upgrade sbt-jni
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4b13641..47f4fdb 100644
--- a/README.md
+++ b/README.md
@@ -17,14 +17,18 @@ Since hardware is involved in serial communication, a Scala-only solution is not
## Directory Structure
```
flow/
+├── Documentation Sources for user documentation as published on the website.
+├── dev Firmware samples for serial devices, to make testing easier.
├── flow-core Main Scala source files.
├── flow-native C sources used to implement serial communication.
+│ └── lib_native Compiled native libraries that are published in flow-native.
├── flow-samples Runnable example projects.
├── flow-stream Stream API, used to connect with Akka streams.
-├── project Build configuration.
-└── site Website sources, including documentation.
+└── project Build configuration.
```
+*Website source code is in the git branch 'gh-pages'.*
+
## Build
Detailed documentation on building flow is available on the website (or, equivalently, in [developer.md](Documentation/developer.md)).