README.md 4.49 KB
Newer Older
Tim Sneath's avatar
Tim Sneath committed
1
# [![Flutter logo][]][flutter.dev]
2 3

[![Build Status - Cirrus][]][Build status]
Tim Sneath's avatar
Tim Sneath committed
4
[![Gitter Channel][]][Gitter badge]
James George's avatar
James George committed
5
[![Twitter handle][]][Twitter badge]
6

7
Flutter is Google's SDK for crafting beautiful, fast user experiences for
8
mobile, web, and desktop from a single codebase. Flutter works with existing
9 10
code, is used by developers and organizations around the world, and is free
and open source.
Adam Barth's avatar
Adam Barth committed
11

Tim Sneath's avatar
Tim Sneath committed
12
## Documentation
Adam Barth's avatar
Adam Barth committed
13

Tim Sneath's avatar
Tim Sneath committed
14 15 16 17
* [Install Flutter](https://flutter.dev/get-started/)
* [Flutter documentation](https://flutter.dev/docs)
* [Development wiki](https://github.com/flutter/flutter/wiki)
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
18 19 20 21

For announcements about new releases and breaking changes, follow the
[flutter-announce@googlegroups.com](https://groups.google.com/forum/#!forum/flutter-announce)
mailing list.
Adam Barth's avatar
Adam Barth committed
22

Tim Sneath's avatar
Tim Sneath committed
23
## About Flutter
Adam Barth's avatar
Adam Barth committed
24

Tim Sneath's avatar
Tim Sneath committed
25 26
We think Flutter will help you create beautiful, fast apps, with a productive,
extensible and open development model.
27

28
### Beautiful user experiences
29

Tim Sneath's avatar
Tim Sneath committed
30 31 32
We want to enable designers to deliver their full creative vision without being
forced to water it down due to limitations of the underlying framework.
Flutter's [layered architecture] gives you control over every pixel on the
33 34
screen and its powerful compositing capabilities let you overlay and animate
graphics, video, text, and controls without limitation. Flutter includes a full
Tim Sneath's avatar
Tim Sneath committed
35 36
[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
iOS and Android.
37

Tim Sneath's avatar
Tim Sneath committed
38
![Reflectly hero image][Reflectly hero image]
39

40
### Fast results
41

42
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
Alex's avatar
Alex committed
43
library that underpins Chrome and Android: [Skia]. We architected Flutter to
Tim Sneath's avatar
Tim Sneath committed
44 45
support glitch-free, jank-free graphics at the native speed of your device.
Flutter code is powered by the world-class [Dart platform], which enables
46 47 48
compilation to 32-bit and 64-bit ARM machine code for iOS and Android, as well
as JavaScript for the web and Intel x64 for desktop devices.

49
![Dart platform diagram][]
50

Tim Sneath's avatar
Tim Sneath committed
51
### Productive development
52

Tim Sneath's avatar
Tim Sneath committed
53 54
Flutter offers stateful hot reload, allowing you to make changes to your code
and see the results instantly without restarting your app or losing its state.
55

Tim Sneath's avatar
Tim Sneath committed
56
[![Hot reload animation][]][Hot reload]
57

Tim Sneath's avatar
Tim Sneath committed
58
### Extensible and open model
59

60
Flutter works with any development tool (or none at all) but includes editor
61 62 63
plug-ins for both [Visual Studio Code] and [IntelliJ / Android Studio]. Flutter
provides [thousands of packages][Flutter packages] to speed your development,
regardless of your target platform. And accessing other native code is easy,
64
with support for both [FFI] and [platform-specific APIs][platform channels].
65

66
Flutter is a fully open-source project, and we welcome contributions.
Tim Sneath's avatar
Tim Sneath committed
67 68
Information on how to get started can be found at our
[contributor guide](CONTRIBUTING.md).
69

Tim Sneath's avatar
Tim Sneath committed
70
[Flutter logo]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/flutter-lockup.png
Tim Sneath's avatar
Tim Sneath committed
71
[flutter.dev]: https://flutter.dev
72 73 74
[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
[Gitter Channel]: https://badges.gitter.im/flutter/flutter.svg
Tim Sneath's avatar
Tim Sneath committed
75
[Gitter badge]: https://gitter.im/flutter/flutter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
James George's avatar
James George committed
76 77
[Twitter handle]: https://img.shields.io/twitter/follow/flutterdev.svg?style=social&label=Follow
[Twitter badge]: https://twitter.com/intent/follow?screen_name=flutterdev
Tim Sneath's avatar
Tim Sneath committed
78 79 80 81
[layered architecture]: https://flutter.dev/docs/resources/inside-flutter
[widget catalog]: https://flutter.dev/widgets/
[Reflectly hero image]: https://github.com/flutter/website/blob/master/src/images/homepage/reflectly-hero-600px.png
[Skia]: https://skia.org/
82
[Dart platform]: https://dart.dev/
83
[Dart platform diagram]: https://github.com/flutter/website/blob/master/src/images/homepage/dart-diagram-small.png
Tim Sneath's avatar
Tim Sneath committed
84 85 86 87
[Hot reload animation]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/tools/android-studio/hot-reload.gif
[Hot reload]: https://flutter.dev/docs/development/tools/hot-reload
[Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
[IntelliJ / Android Studio]: https://plugins.jetbrains.com/plugin/9212-flutter
88
[Flutter packages]: https://pub.dev/flutter
89 90
[FFI]: https://flutter.dev/docs/development/platform-integration/c-interop
[platform channels]: https://flutter.dev/docs/development/platform-integration/platform-channels
James George's avatar
James George committed
91
[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel