README.md 5.74 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
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5631/badge)](https://bestpractices.coreinfrastructure.org/projects/5631)
7

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

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

Tim Sneath's avatar
Tim Sneath committed
15 16 17 18
* [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)
19

Tim Sneath's avatar
Tim Sneath committed
20
For announcements about new releases, follow the
21
[flutter-announce@googlegroups.com](https://groups.google.com/forum/#!forum/flutter-announce)
Tim Sneath's avatar
Tim Sneath committed
22 23
mailing list. Our documentation also tracks [breaking
changes](https://flutter.dev/docs/release/breaking-changes) across releases.
Adam Barth's avatar
Adam Barth committed
24

25 26
## Terms of service

Tim Sneath's avatar
Tim Sneath committed
27 28 29
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
30

Tim Sneath's avatar
Tim Sneath committed
31 32 33 34 35
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).
36

Tim Sneath's avatar
Tim Sneath committed
37
## About Flutter
Adam Barth's avatar
Adam Barth committed
38

Tim Sneath's avatar
Tim Sneath committed
39
We think Flutter will help you create beautiful, fast apps, with a productive,
Tim Sneath's avatar
Tim Sneath committed
40 41 42
extensible and open development model, whether you're targeting iOS or Android,
web, Windows, macOS, Linux or embedding it as the UI toolkit for a platform of
your choice.
43

44
### Beautiful user experiences
45

Tim Sneath's avatar
Tim Sneath committed
46 47 48
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
49 50
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
51 52 53
[set of widgets][widget catalog] that deliver pixel-perfect experiences whether
you're building for iOS ([Cupertino]) or Android ([Material]), along with
support for customizing or creating entirely new visual components.
54

55
<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>
56

57
### Fast results
58

59
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
Alex's avatar
Alex committed
60
library that underpins Chrome and Android: [Skia]. We architected Flutter to
Tim Sneath's avatar
Tim Sneath committed
61 62
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
63 64 65
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.

66
<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>
67

Tim Sneath's avatar
Tim Sneath committed
68
### Productive development
69

Tim Sneath's avatar
Tim Sneath committed
70 71
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.
72

Tim Sneath's avatar
Tim Sneath committed
73
[![Hot reload animation][]][Hot reload]
74

Tim Sneath's avatar
Tim Sneath committed
75
### Extensible and open model
76

Tim Sneath's avatar
Tim Sneath committed
77 78 79 80 81 82
Flutter works with any development tool (or none at all), and also includes
editor plug-ins for both [Visual Studio Code] and [IntelliJ / Android Studio].
Flutter provides [tens of thousands of packages][Flutter packages] to speed your
development, regardless of your target platform. And accessing other native code
is easy, with support for both [FFI] and [platform-specific APIs][platform
channels].
83

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

88
[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
89
[flutter.dev]: https://flutter.dev
90 91
[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
92 93
[Discord instructions]: https://github.com/flutter/flutter/wiki/Chat
[Discord badge]: https://img.shields.io/discord/608014603317936148
James George's avatar
James George committed
94 95
[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
96
[layered architecture]: https://flutter.dev/docs/resources/inside-flutter
Tim Sneath's avatar
Tim Sneath committed
97
[architectural overview]: https://docs.flutter.dev/resources/architectural-overview
Tim Sneath's avatar
Tim Sneath committed
98
[widget catalog]: https://flutter.dev/widgets/
Tim Sneath's avatar
Tim Sneath committed
99 100
[Cupertino]: https://docs.flutter.dev/development/ui/widgets/cupertino
[Material]: https://docs.flutter.dev/development/ui/widgets/material
Tim Sneath's avatar
Tim Sneath committed
101
[Skia]: https://skia.org/
102
[Dart platform]: https://dart.dev/
103
[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
104
[Hot reload]: https://docs.flutter.dev/development/tools/hot-reload
Tim Sneath's avatar
Tim Sneath committed
105 106
[Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
[IntelliJ / Android Studio]: https://plugins.jetbrains.com/plugin/9212-flutter
107
[Flutter packages]: https://pub.dev/flutter
108 109
[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
110
[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel