flutter/examples/README.md
Michael Thomsen 2c063b7ca5
Clean up the examples readme (#22419)
A few changes:

* Remove the search tip (it relies on searching for the new keyword which we no longer use)
* Remove mentioning of examples that are either stale or only used for internal purposes (such as test)
* Cross-link to the samples repo
2018-10-08 08:45:24 +02:00

42 lines
1.7 KiB
Markdown

Flutter Examples
================
This directory contains several examples of using Flutter. To run an example,
use `flutter run` inside that example's directory. See the [getting started
guide](https://flutter.io/getting-started/) to install the `flutter` tool.
For additional samples, see the
[`flutter/samples`](https://github.com/flutter/samples) repo.
Available examples include:
- **Hello, world** The [hello world app](hello_world) is a minimal Flutter app
that shows the text "hello, world."
- **Flutter gallery** The [flutter gallery app](flutter_gallery) showcases
Flutter's widgets, including its implementation of [material
design](https://material.google.com/).
- **Layers** The [layers vignettes](layers) show how to use the various layers
in the Flutter framework. For details, see the [layers
README](layers/README.md).
- **Platform Channel** The [platform channel app](platform_channel) demonstrates
how to connect a Flutter app to platform-specific APIs. For documentation, see
<https://flutter.io/platform-channels/>.
- **Platform Channel Swift** The [platform channel swift
app](platform_channel_swift) is the same as [platform
channel](platform_channel) but the iOS version is in Swift and there is no
Android version.
## Notes
Note on Gradle wrapper files in `.gitignore`:
Gradle wrapper files should normally be checked into source control. The example
projects don't do that to avoid having several copies of the wrapper binary in
the Flutter repo. Instead, the Gradle wrapper is injected by Flutter tooling,
and the wrapper files are .gitignore'd to avoid making the Flutter repository
dirty as a side effect of running the examples.