blob: e9c819271ce9f539b007097a3d405130b9becd3e (
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
|
---
layout: page
title: Documentation
---
-----
## Migrating from 2.x to 3.x
The latest release, 3.0.0, introduces some source compatibility-breaking changes:
- Organization and packages have been changed from `com.github.jodersky` to `ch.jodersky`
- A new major version of the native library has been released, `libflow4`
It should be sufficient to change any imports that previously used "com.github.jodersky.flow" to "ch.jodersky.flow".
In case you manually installed the native library, you will also need to upgrade to libflow4 (see the Developer Guide for more information).
-----
## Documentation
Start by reading the manual and checking out some examples.
- <i class="fa fa-book"></i> [Manual]({{site.version_docs}}/manual)
Explains how to get started and how to use all features. Definitive guide to using flow.
- <i class="fa fa-book"></i> [Examples](https://github.com/jodersky/flow/tree/master/flow-samples)
See some very simple, working demo applications.
- <i class="fa fa-code"></i> [API documentation]({{site.version_docs}}/api/index.html#ch.jodersky.flow.Serial$)
Browse flow's API.
- <i class="fa fa-book"></i> [Developer Guide]({{site.version_docs}}/developer)
Instructions on building and publishing flow.
## Help
Have a question or suggestion? Found a bug? There are several channels to get help.
- <i class="fa fa-bug"></i> [Issues](https://github.com/jodersky/flow/issues)
Check known issues or file a new one. This is also the place to go for long questions or propositions.
- <i class="fa fa-comments"></i> [Chat](https://gitter.im/jodersky/flow)
Gitter chat for simple inquiries.
## Use cases
Get inspired by some real projects that use flow.
- [Virtual Cockpit](https://github.com/project-condor/mavigator) part of [Project Condor](https://project-condor.github.io/), a do-it-yourself drone.
- [Hyperion](https://github.com/mthmulders/hyperion) back-end, part of a web-based energy dashboard for "smart meters".
- [(add yours by opening an issue)](https://github.com/jodersky/flow/issues)
|
