blob: 23f7be70124e62518fa5d3ebaeaf81fd16d08e04 [file] [log] [blame] [view]
Tim Sneathd62635a2019-04-08 18:02:09 -07001# [![Flutter logo][]][flutter.dev]
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -05002
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -05003[![Build Status - Cirrus][]][Build status]
Tim Sneathd62635a2019-04-08 18:02:09 -07004[![Gitter Channel][]][Gitter badge]
James George384a44d2019-11-21 05:45:58 +05305[![Twitter handle][]][Twitter badge]
Michael Thomsen7f0f9382018-08-27 11:11:14 +02006
Tim Sneath05c3f7b2019-10-29 15:57:14 -07007Flutter is Google's SDK for crafting beautiful, fast user experiences for
8mobile, web and desktop from a single codebase. Flutter works with existing
9code, is used by developers and organizations around the world, and is free
10and open source.
Michael Thomsen7f0f9382018-08-27 11:11:14 +020011
Tim Sneathd62635a2019-04-08 18:02:09 -070012## Documentation
Adam Barth7b0bbdb2015-10-30 11:16:58 -070013
Tim Sneathd62635a2019-04-08 18:02:09 -070014* [Install Flutter](https://flutter.dev/get-started/)
15* [Flutter documentation](https://flutter.dev/docs)
16* [Development wiki](https://github.com/flutter/flutter/wiki)
17* [Contributing to Flutter](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md)
Ian Hicksoncf2fba72018-11-06 13:41:09 -080018
19For announcements about new releases and breaking changes, follow the
20[flutter-announce@googlegroups.com](https://groups.google.com/forum/#!forum/flutter-announce)
21mailing list.
Adam Barth576795d2015-11-08 21:33:00 -080022
Tim Sneathd62635a2019-04-08 18:02:09 -070023## About Flutter
Adam Barth7b0bbdb2015-10-30 11:16:58 -070024
Tim Sneathd62635a2019-04-08 18:02:09 -070025We think Flutter will help you create beautiful, fast apps, with a productive,
26extensible and open development model.
Filip Hracek53e23532017-07-12 10:12:25 -070027
Tim Sneath05c3f7b2019-10-29 15:57:14 -070028### Beautiful user experiences
Filip Hracek39d2deb2017-07-12 10:58:12 -070029
Tim Sneathd62635a2019-04-08 18:02:09 -070030We want to enable designers to deliver their full creative vision without being
31forced to water it down due to limitations of the underlying framework.
32Flutter's [layered architecture] gives you control over every pixel on the
33screen, and its powerful compositing capabilities let you overlay and animate
34graphics, video, text and controls without limitation. Flutter includes a full
35[set of widgets][widget catalog] that deliver pixel-perfect experiences on both
36iOS and Android.
Michael Thomsen7f0f9382018-08-27 11:11:14 +020037
Tim Sneathd62635a2019-04-08 18:02:09 -070038![Reflectly hero image][Reflectly hero image]
Filip Hracek53e23532017-07-12 10:12:25 -070039
Tim Sneath05c3f7b2019-10-29 15:57:14 -070040### Fast results
Filip Hracek53e23532017-07-12 10:12:25 -070041
Tim Sneathd62635a2019-04-08 18:02:09 -070042Flutter is fast. It's powered by the same hardware-accelerated [Skia] 2D
43graphics library that underpins Chrome and Android. We architected Flutter to
44support glitch-free, jank-free graphics at the native speed of your device.
45Flutter code is powered by the world-class [Dart platform], which enables
Tim Sneath05c3f7b2019-10-29 15:57:14 -070046compilation to 32-bit and 64-bit ARM machine code for iOS and Android, as well
47as JavaScript for the web and Intel x64 for desktop devices.
48
Tim Sneath1f361672020-01-08 12:43:02 -080049![Dart platform diagram][]
Filip Hracek53e23532017-07-12 10:12:25 -070050
Tim Sneathd62635a2019-04-08 18:02:09 -070051### Productive development
Filip Hracek53e23532017-07-12 10:12:25 -070052
Tim Sneathd62635a2019-04-08 18:02:09 -070053Flutter offers stateful hot reload, allowing you to make changes to your code
54and see the results instantly without restarting your app or losing its state.
Filip Hracek53e23532017-07-12 10:12:25 -070055
Tim Sneathd62635a2019-04-08 18:02:09 -070056[![Hot reload animation][]][Hot reload]
Filip Hracek53e23532017-07-12 10:12:25 -070057
Tim Sneathd62635a2019-04-08 18:02:09 -070058### Extensible and open model
Filip Hracek53e23532017-07-12 10:12:25 -070059
Tim Sneath05c3f7b2019-10-29 15:57:14 -070060Flutter works with any development tool (or none at all), but includes editor
61plug-ins for both [Visual Studio Code] and [IntelliJ / Android Studio]. Flutter
62provides [thousands of packages][Flutter packages] to speed your development,
63regardless of your target platform. And accessing other native code is easy,
Dan Field24f39d42020-01-02 11:47:28 -080064with support for both [FFI] and [platform-specific APIs][platform channels].
Filip Hracek53e23532017-07-12 10:12:25 -070065
Tim Sneathd62635a2019-04-08 18:02:09 -070066Flutter is a fully open source project, and we welcome contributions.
67Information on how to get started can be found at our
68[contributor guide](CONTRIBUTING.md).
Filip Hracek53e23532017-07-12 10:12:25 -070069
Tim Sneath12e52bd2020-01-17 13:43:23 -080070[Flutter logo]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/flutter-lockup.png
Tim Sneathd62635a2019-04-08 18:02:09 -070071[flutter.dev]: https://flutter.dev
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -050072[Build Status - Cirrus]: https://api.cirrus-ci.com/github/flutter/flutter.svg
73[Build status]: https://cirrus-ci.com/github/flutter/flutter/master
Patrice Chalinf8e5b9c2019-01-23 21:54:15 -050074[Gitter Channel]: https://badges.gitter.im/flutter/flutter.svg
Tim Sneathd62635a2019-04-08 18:02:09 -070075[Gitter badge]: https://gitter.im/flutter/flutter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
James George384a44d2019-11-21 05:45:58 +053076[Twitter handle]: https://img.shields.io/twitter/follow/flutterdev.svg?style=social&label=Follow
77[Twitter badge]: https://twitter.com/intent/follow?screen_name=flutterdev
Tim Sneathd62635a2019-04-08 18:02:09 -070078[layered architecture]: https://flutter.dev/docs/resources/inside-flutter
79[widget catalog]: https://flutter.dev/widgets/
80[Reflectly hero image]: https://github.com/flutter/website/blob/master/src/images/homepage/reflectly-hero-600px.png
81[Skia]: https://skia.org/
Kate Lovett054d9bb2019-05-14 10:35:00 -070082[Dart platform]: https://dart.dev/
Tim Sneath1f361672020-01-08 12:43:02 -080083[Dart platform diagram]: https://github.com/flutter/website/blob/master/src/images/homepage/dart-diagram-small.png
Tim Sneathd62635a2019-04-08 18:02:09 -070084[Hot reload animation]: https://raw.githubusercontent.com/flutter/website/master/src/_assets/image/tools/android-studio/hot-reload.gif
85[Hot reload]: https://flutter.dev/docs/development/tools/hot-reload
86[Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
87[IntelliJ / Android Studio]: https://plugins.jetbrains.com/plugin/9212-flutter
Kate Lovett054d9bb2019-05-14 10:35:00 -070088[Flutter packages]: https://pub.dev/flutter
Tim Sneath05c3f7b2019-10-29 15:57:14 -070089[FFI]: https://flutter.dev/docs/development/platform-integration/c-interop
90[platform channels]: https://flutter.dev/docs/development/platform-integration/platform-channels
James George384a44d2019-11-21 05:45:58 +053091[interop example]: https://github.com/flutter/flutter/tree/master/examples/platform_channel