blob: 1ee4ed198eb798fd496f7b6a1e3eb604b83efddc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Serial communication library for Akka and Scala.">
<link rel="shortcut icon" type="image/png" href="https://jodersky.github.io/flow/assets/images/logo.png"/>
<title>flow - Documentation</title>
<link rel="stylesheet" href="https://jodersky.github.io/flow/assets/lib/bootstrap/css/bootstrap.min.css">
<link rel="stylesheet" href="https://jodersky.github.io/flow/assets/lib/fontawesome/css/font-awesome.min.css">
<link rel="stylesheet" href="https://jodersky.github.io/flow/assets/stylesheets/solarized-dark.css">
<link rel="stylesheet" href="https://jodersky.github.io/flow/assets/stylesheets/main.css">
<script src="https://jodersky.github.io/flow/assets/lib/jquery/jquery-1.11.3.min.js"></script>
</head>
<body>
<header>
<nav class="navbar navbar-static-top navbar-default">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="https://jodersky.github.io/flow">
<img src="https://jodersky.github.io/flow/assets/images/logo.png" alt="flow logo">
flow
</a>
</div>
<ul class="nav navbar-nav navbar-right">
<li><a href="https://jodersky.github.io/flow/documentation">Documentation & Help</a></li>
<li><a href="https://jodersky.github.io/flow/downloads">Download</a></li>
<li><a href="https://github.com/jodersky/flow">GitHub</a></li>
</ul>
</div>
</nav>
</header>
<div class="container">
<h2 id="documentation">Documentation</h2>
<p>Start by reading the manual and checking out some examples.</p>
<ul>
<li>
<p><i class="fa fa-book"></i> <a href="manual.html">Manual</a>
Explains how to get started and how all features work. Definitive guide to using flow.</p>
</li>
<li>
<p><i class="fa fa-book"></i> <a href="https://github.com/jodersky/flow/tree/master/flow-samples">Examples</a>
See some very simple, working demo applications.</p>
</li>
<li>
<p><i class="fa fa-code"></i> <a href="https://jodersky.github.io/flow/latest/api#com.github.jodersky.flow.Serial$">API documentation</a>
Browse flow’s API.</p>
</li>
</ul>
<h2 id="help">Help</h2>
<p>Have a question or suggestion? Found a bug? There are several channels to get help.</p>
<ul>
<li>
<p><i class="fa fa-bug"></i> <a href="https://github.com/jodersky/flow/issues">Issues</a>
Check known issues or file a new one. This is also the place to go for long questions or propositions.</p>
</li>
<li>
<p><i class="fa fa-comments"></i> <a href="https://gitter.im/jodersky/flow">Chat</a>
Gitter chat for simple inquiries.</p>
</li>
</ul>
<h2 id="use-cases">Use cases</h2>
<p>Get inspired by some real projects that use flow.</p>
<ul>
<li>
<p><a href="https://github.com/project-condor/vfd">Virtual Cockpit</a> part of <a href="https://project-condor.github.io/">Project Condor</a>, a do-it-yourself drone.</p>
</li>
<li>
<p><a href="https://github.com/jodersky/flow/issues">(add yours by opening an issue)</a></p>
</li>
</ul>
</div>
<script src="https://jodersky.github.io/flow/assets/lib/bootstrap/js/bootstrap.min.js"></script>
</body>
</html>
|