README.md 6.71 KB
Newer Older
1 2 3 4 5 6 7 8
<a href="https://flutter.dev/">
  <h1 align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/cms-storage-bucket/6e19fee6b47b36ca613f.png">
      <img alt="Flutter" src="https://storage.googleapis.com/cms-storage-bucket/c823e53b3a1a7b0d36a9.png">
    </picture>
  </h1>
</a>
9 10

[![Build Status - Cirrus][]][Build status]
11
[![Discord badge][]][Discord instructions]
James George's avatar
James George committed
12
[![Twitter handle][]][Twitter badge]
13
[![codecov](https://codecov.io/gh/flutter/flutter/branch/master/graph/badge.svg?token=11yDrJU2M2)](https://codecov.io/gh/flutter/flutter)
14
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5631/badge)](https://bestpractices.coreinfrastructure.org/projects/5631)
Drew Roen's avatar
Drew Roen committed
15
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/flutter/flutter/badge)](https://deps.dev/project/github/flutter%2Fflutter)
16
[![SLSA 1](https://slsa.dev/images/gh-badge-level1.svg)](https://slsa.dev)
17

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

Tim Sneath's avatar
Tim Sneath committed
23
## Documentation
Adam Barth's avatar
Adam Barth committed
24

Tim Sneath's avatar
Tim Sneath committed
25
* [Install Flutter](https://flutter.dev/get-started/)
26
* [Flutter documentation](https://docs.flutter.dev/)
Tim Sneath's avatar
Tim Sneath committed
27 28
* [Development wiki](https://github.com/flutter/flutter/wiki)
* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
29

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

35 36
## Terms of service

Tim Sneath's avatar
Tim Sneath committed
37
The Flutter tool may occasionally download resources from Google servers. By
38
downloading or using the Flutter SDK, you agree to the Google Terms of Service:
Tim Sneath's avatar
Tim Sneath committed
39
https://policies.google.com/terms
40

Tim Sneath's avatar
Tim Sneath committed
41 42 43 44 45
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).
46

Tim Sneath's avatar
Tim Sneath committed
47
## About Flutter
Adam Barth's avatar
Adam Barth committed
48

Tim Sneath's avatar
Tim Sneath committed
49
We think Flutter will help you create beautiful, fast apps, with a productive,
Tim Sneath's avatar
Tim Sneath committed
50 51 52
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.
53

54
### Beautiful user experiences
55

Tim Sneath's avatar
Tim Sneath committed
56 57 58
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
59 60
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
61
[set of widgets][widget catalog] that deliver pixel-perfect experiences whether
62
you're building for iOS ([Cupertino]) or other platforms ([Material]), along with
Tim Sneath's avatar
Tim Sneath committed
63
support for customizing or creating entirely new visual components.
64

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

67
### Fast results
68

69
Flutter is fast. It's powered by the same hardware-accelerated 2D graphics
Alex's avatar
Alex committed
70
library that underpins Chrome and Android: [Skia]. We architected Flutter to
Tim Sneath's avatar
Tim Sneath committed
71 72
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
73 74 75
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.

76
<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>
77

Tim Sneath's avatar
Tim Sneath committed
78
### Productive development
79

80
Flutter offers [stateful hot reload][Hot reload], allowing you to make changes to your code
Tim Sneath's avatar
Tim Sneath committed
81
and see the results instantly without restarting your app or losing its state.
82

Tim Sneath's avatar
Tim Sneath committed
83
[![Hot reload animation][]][Hot reload]
84

Tim Sneath's avatar
Tim Sneath committed
85
### Extensible and open model
86

Tim Sneath's avatar
Tim Sneath committed
87 88 89 90
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
91
is easy, with support for both FFI ([on Android][Android FFI], [on iOS][iOS FFI],
92 93
[on macOS][macOS FFI], and [on Windows][Windows FFI]) as well as
[platform-specific APIs][platform channels].
94

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

Tim Sneath's avatar
Tim Sneath committed
99
[flutter.dev]: https://flutter.dev
100 101
[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
102
[Discord instructions]: https://github.com/flutter/flutter/wiki/Chat
103
[Discord badge]: https://img.shields.io/discord/608014603317936148?logo=discord
James George's avatar
James George committed
104 105
[Twitter handle]: https://img.shields.io/twitter/follow/flutterdev.svg?style=social&label=Follow
[Twitter badge]: https://twitter.com/intent/follow?screen_name=flutterdev
106
[layered architecture]: https://docs.flutter.dev/resources/inside-flutter
Tim Sneath's avatar
Tim Sneath committed
107
[architectural overview]: https://docs.flutter.dev/resources/architectural-overview
Tim Sneath's avatar
Tim Sneath committed
108
[widget catalog]: https://flutter.dev/widgets/
Tim Sneath's avatar
Tim Sneath committed
109 110
[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
111
[Skia]: https://skia.org/
112
[Dart platform]: https://dart.dev/
113
[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
114
[Hot reload]: https://docs.flutter.dev/development/tools/hot-reload
Tim Sneath's avatar
Tim Sneath committed
115 116
[Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
[IntelliJ / Android Studio]: https://plugins.jetbrains.com/plugin/9212-flutter
117
[Flutter packages]: https://pub.dev/flutter
118
[Android FFI]: https://docs.flutter.dev/development/platform-integration/android/c-interop
119
[iOS FFI]: https://docs.flutter.dev/development/platform-integration/ios/c-interop
120
[macOS FFI]: https://docs.flutter.dev/development/platform-integration/macos/c-interop
121
[Windows FFI]: https://docs.flutter.dev/development/platform-integration/windows/building#integrating-with-windows
122
[platform channels]: https://docs.flutter.dev/development/platform-integration/platform-channels
James George's avatar
James George committed
123
[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel