From 5ee33d78cf3ec49b9218917ee37a89702c88c86f Mon Sep 17 00:00:00 2001 From: Chris Bracken Date: Fri, 13 Apr 2018 15:46:54 -0700 Subject: [PATCH] Minor update to README (flutter/engine#5003) * Adds a docs directory with an architecture diagram from @chinmaygarde. * Excludes the flutter/docs directory from license script. --- engine/src/flutter/README.md | 11 ++++++++--- engine/src/flutter/docs/flutter_overview.svg | 1 + engine/src/flutter/tools/licenses/lib/main.dart | 1 + 3 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 engine/src/flutter/docs/flutter_overview.svg diff --git a/engine/src/flutter/README.md b/engine/src/flutter/README.md index 763035baaee..e52c496b975 100644 --- a/engine/src/flutter/README.md +++ b/engine/src/flutter/README.md @@ -6,9 +6,14 @@ Flutter is a new way to build high-performance, cross-platform mobile apps. Flutter is optimized for today's, and tomorrow's, mobile devices. We are focused on low-latency input and high frame rates on Android and iOS. -The Flutter Engine is the runtime environment for hosting Flutter applications. -Most developers will interact with Flutter via the Flutter Framework and APIs, -which run inside the engine. +The Flutter Engine is a portable runtime for hosting +[Flutter](https://flutter.io) applications. It implements Flutter's core +libraries, including animation and graphics, file and network I/O, +accessibility support, plugin architecture, and a Dart runtime and compile +toolchain. Most developers wil interact with Flutter via the [Flutter +Framework](https://github.com/flutter/flutter), which provides a modern, +reactive framework, and a rich set of platform, layout and foundation widgets. + _Flutter is still under development and we continue to add features._ However, it is ready for use by early adopters who are willing to deal diff --git a/engine/src/flutter/docs/flutter_overview.svg b/engine/src/flutter/docs/flutter_overview.svg new file mode 100644 index 00000000000..5955fcd2c93 --- /dev/null +++ b/engine/src/flutter/docs/flutter_overview.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/engine/src/flutter/tools/licenses/lib/main.dart b/engine/src/flutter/tools/licenses/lib/main.dart index 2cf747123ed..59443943a36 100644 --- a/engine/src/flutter/tools/licenses/lib/main.dart +++ b/engine/src/flutter/tools/licenses/lib/main.dart @@ -2106,6 +2106,7 @@ class RepositoryFlutterDirectory extends RepositoryDirectory { bool shouldRecurse(fs.IoNode entry) { return entry.name != 'testing' && entry.name != 'tools' + && entry.name != 'docs' && entry.name != 'examples' && entry.name != 'build' && entry.name != 'travis'