aboutsummaryrefslogtreecommitdiff
path: root/documentation/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/index.html')
-rw-r--r--documentation/index.html99
1 files changed, 99 insertions, 0 deletions
diff --git a/documentation/index.html b/documentation/index.html
new file mode 100644
index 0000000..f3ccf64
--- /dev/null
+++ b/documentation/index.html
@@ -0,0 +1,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="/assets/images/logo.png"/>
+
+ <title>flow - Documentation</title>
+
+ <link rel="stylesheet" href="/assets/lib/bootstrap/css/bootstrap.min.css">
+ <link rel="stylesheet" href="/assets/lib/fontawesome/css/font-awesome.min.css">
+ <link rel="stylesheet" href="/assets/stylesheets/solarized-dark.css">
+ <link rel="stylesheet" href="/assets/stylesheets/main.css">
+
+ <script src="/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="/">
+ <img src="/assets/images/logo.png" alt="flow logo">
+ flow
+ </a>
+ </div>
+ <ul class="nav navbar-nav navbar-right">
+ <li><a href="/documentation">Documentation & Help</a></li>
+ <li><a href="/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="/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="/assets/lib/bootstrap/js/bootstrap.min.js"></script>
+</body>
+</html>
+
+