README.md 5.1 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

24 25 26 27 28 29
## Terms of service

The Flutter tool may occasionally download resources from Google servers. By downloading or using the Flutter SDK you agree to the Google Terms of Service: https://policies.google.com/terms

For example, when installed from GitHub (as opposed to from a prepackaged archive), the Flutter tool will download the Dart SDK from Google servers immediately when first run, as it is used to execute the "flutter" tool itself. This will also occur when Flutter is upgraded (e.g. by running the "flutter upgrade" command).

Tim Sneath's avatar
Tim Sneath committed
30
## About Flutter
Adam Barth's avatar
Adam Barth committed
31

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

35
### Beautiful user experiences
36

Tim Sneath's avatar
Tim Sneath committed
37 38 39
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
40 41
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
42 43
[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
iOS and Android.
44

45
<p align="center"><img src="https://github.com/flutter/website/blob/main/src/assets/images/docs/homepage/reflectly-hero-600px.png?raw=true" alt="Reflectly hero image"></p>
46

47
### Fast results
48

49
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
Alex's avatar
Alex committed
50
library that underpins Chrome and Android: [Skia]. We architected Flutter to
Tim Sneath's avatar
Tim Sneath committed
51 52
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
53 54 55
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.

56
<p align="center"><img src="https://github.com/flutter/website/blob/main/src/assets/images/docs/homepage/dart-diagram-small.png?raw=true" alt="Dart diagram"></p>
57

Tim Sneath's avatar
Tim Sneath committed
58
### Productive development
59

Tim Sneath's avatar
Tim Sneath committed
60 61
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.
62

Tim Sneath's avatar
Tim Sneath committed
63
[![Hot reload animation][]][Hot reload]
64

Tim Sneath's avatar
Tim Sneath committed
65
### Extensible and open model
66

67
Flutter works with any development tool (or none at all) but includes editor
68 69 70
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,
71
with support for both [FFI] and [platform-specific APIs][platform channels].
72

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

77
[Flutter logo]: https://github.com/flutter/website/blob/archived-master/src/_assets/image/flutter-lockup-bg.jpg?raw=true
Tim Sneath's avatar
Tim Sneath committed
78
[flutter.dev]: https://flutter.dev
79 80
[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
81 82
[Discord instructions]: https://github.com/flutter/flutter/wiki/Chat
[Discord badge]: https://img.shields.io/discord/608014603317936148
James George's avatar
James George committed
83 84
[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
85 86 87
[layered architecture]: https://flutter.dev/docs/resources/inside-flutter
[widget catalog]: https://flutter.dev/widgets/
[Skia]: https://skia.org/
88
[Dart platform]: https://dart.dev/
89
[Hot reload animation]: https://github.com/flutter/website/blob/main/src/assets/images/docs/tools/android-studio/hot-reload.gif?raw=true
Tim Sneath's avatar
Tim Sneath committed
90 91 92
[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
93
[Flutter packages]: https://pub.dev/flutter
94 95
[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
96
[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel