From 06ec8d3b41beb469d845626e36a246ee09300fa7 Mon Sep 17 00:00:00 2001 From: Tim Sneath Date: Wed, 28 Nov 2018 15:56:58 -0800 Subject: [PATCH] Updating readme templates for newly created projects (#24725) We hypothesize that many first-time users creating a new project will look at the README.md as a starting point for "what next". As we've updated our documentation particularly for new users, having better links to our codelabs and cookbooks will help them be productive. --- packages/flutter_tools/templates/app/README.md.tmpl | 12 ++++++++++-- .../flutter_tools/templates/package/README.md.tmpl | 9 +++++++-- .../flutter_tools/templates/plugin/README.md.tmpl | 10 +++++++--- 3 files changed, 24 insertions(+), 7 deletions(-) diff --git a/packages/flutter_tools/templates/app/README.md.tmpl b/packages/flutter_tools/templates/app/README.md.tmpl index f140e12b54..af7c7459ae 100644 --- a/packages/flutter_tools/templates/app/README.md.tmpl +++ b/packages/flutter_tools/templates/app/README.md.tmpl @@ -4,5 +4,13 @@ ## Getting Started -For help getting started with Flutter, view our online -[documentation](https://flutter.io/). +This project is a starting point for a Flutter application. + +A few resources to get you started if this is your first Flutter project: + +- [Lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab) +- [Cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook) + +For help getting started with Flutter, view our +[online documentation](https://flutter.io/docs), which offers tutorials, +samples, guidance on mobile development, and a full API reference. diff --git a/packages/flutter_tools/templates/package/README.md.tmpl b/packages/flutter_tools/templates/package/README.md.tmpl index c0bbe5c44b..800b83a5ec 100644 --- a/packages/flutter_tools/templates/package/README.md.tmpl +++ b/packages/flutter_tools/templates/package/README.md.tmpl @@ -4,6 +4,11 @@ ## Getting Started -For help getting started with Flutter, view our online [documentation](https://flutter.io/). +This project is a starting point for a Dart +[package](https://flutter.io/developing-packages/), +a library module containing code that can be shared easily across +multiple Flutter or Dart projects. -For help on editing package code, view the [documentation](https://flutter.io/developing-packages/). +For help getting started with Flutter, view our +[online documentation](https://flutter.io/docs), which offers tutorials, +samples, guidance on mobile development, and a full API reference. diff --git a/packages/flutter_tools/templates/plugin/README.md.tmpl b/packages/flutter_tools/templates/plugin/README.md.tmpl index 0c941feb71..f08ca4a198 100644 --- a/packages/flutter_tools/templates/plugin/README.md.tmpl +++ b/packages/flutter_tools/templates/plugin/README.md.tmpl @@ -4,7 +4,11 @@ ## Getting Started -For help getting started with Flutter, view our online -[documentation](https://flutter.io/). +This project is a starting point for a Flutter +[plug-in package](https://flutter.io/developing-packages/), +a specialized package that includes platform-specific implementation code for +Android and/or iOS. -For help on editing plugin code, view the [documentation](https://flutter.io/developing-packages/#edit-plugin-package). +For help getting started with Flutter, view our +[online documentation](https://flutter.io/docs), which offers tutorials, +samples, guidance on mobile development, and a full API reference.