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

[![Build Status - Cirrus][]][Build status]
4
[![Discord badge][]][Discord instructions]
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

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

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

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

29
### Beautiful user experiences
30

Tim Sneath's avatar
Tim Sneath committed
31 32 33
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
34 35
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
36 37
[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
iOS and Android.
38

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

41
### Fast results
42

43
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
Alex's avatar
Alex committed
44
library that underpins Chrome and Android: [Skia]. We architected Flutter to
Tim Sneath's avatar
Tim Sneath committed
45 46
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
47 48 49
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.

50
![Dart platform diagram][]
51

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

Tim Sneath's avatar
Tim Sneath committed
54 55
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.
56

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

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

61
Flutter works with any development tool (or none at all) but includes editor
62 63 64
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,
65
with support for both [FFI] and [platform-specific APIs][platform channels].
66

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

71
[Flutter logo]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/flutter-lockup-bg.jpg
Tim Sneath's avatar
Tim Sneath committed
72
[flutter.dev]: https://flutter.dev
73 74
[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
75 76
[Discord instructions]: https://github.com/flutter/flutter/wiki/Chat
[Discord badge]: https://img.shields.io/discord/608014603317936148
James George's avatar
James George committed
77 78
[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
79 80
[layered architecture]: https://flutter.dev/docs/resources/inside-flutter
[widget catalog]: https://flutter.dev/widgets/
81
[Reflectly hero image]: https://github.com/flutter/website/blob/master/src/images/homepage/reflectly-hero-600px.png
Tim Sneath's avatar
Tim Sneath committed
82
[Skia]: https://skia.org/
83
[Dart platform]: https://dart.dev/
84 85
[Dart platform diagram]: https://github.com/flutter/website/blob/master/src/images/homepage/dart-diagram-small.png
[Hot reload animation]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/tools/android-studio/hot-reload.gif
Tim Sneath's avatar
Tim Sneath committed
86 87 88
[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
89
[Flutter packages]: https://pub.dev/flutter
90 91
[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
92
[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel