aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/README.md7
-rw-r--r--Documentation/basics.md6
2 files changed, 11 insertions, 2 deletions
diff --git a/Documentation/README.md b/Documentation/README.md
new file mode 100644
index 0000000..e7c1d0b
--- /dev/null
+++ b/Documentation/README.md
@@ -0,0 +1,7 @@
+# Contents
+
+1. [Basics - initial concepts and communication protocol](basics.md) (Read this if you are new to flow)
+
+2. [Watching for new ports](watching.md)
+
+3. [Building from source](building.md)
diff --git a/Documentation/basics.md b/Documentation/basics.md
index 1982f66..f18b62a 100644
--- a/Documentation/basics.md
+++ b/Documentation/basics.md
@@ -26,8 +26,10 @@ val settings = SerialSettings(
IO(Serial) ! Serial.Open(port, settings)
def receive = {
- case CommandFailed(cmd: Open, reason: AccessDeniedException) => println("you're not allowed to open that port!")
- case CommandFailed(cmd: Open, reason) => println("could not open port for some other reason: " + reason.getMessage)
+ case CommandFailed(cmd: Open, reason: AccessDeniedException) =>
+ println("you're not allowed to open that port!")
+ case CommandFailed(cmd: Open, reason) =>
+ println("could not open port for some other reason: " + reason.getMessage)
case Opened(settings) => {
val operator = sender
//do stuff with the operator, e.g. context become opened(op)