---
layout: page
title: Documentation
---
## Documentation
Start by reading the manual and checking out some examples.

- <i class="fa fa-book"></i> [Manual](manual.html)
  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.url}}/latest/api#com.github.jodersky.flow.Serial$)
  Browse flow's API.

- <i class="fa fa-book"></i> [Developer Guide](developer.html)
  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/vfd) 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)