From fde7a0aefeccbda2c8d0989a6661bdc85160c538 Mon Sep 17 00:00:00 2001 From: xster Date: Tue, 10 Sep 2019 15:51:28 -0700 Subject: [PATCH] small random notes (#137) --- experimental/add_to_app/README.md | 29 +++++++++++++++---- .../add_to_app/example_module/pubspec.yaml | 2 +- 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/experimental/add_to_app/README.md b/experimental/add_to_app/README.md index 1e027188d..932750bc1 100644 --- a/experimental/add_to_app/README.md +++ b/experimental/add_to_app/README.md @@ -1,7 +1,7 @@ # Add-to-App Sample -***The Add-to-App sample is designed to build with Flutter's `master` channel -and the latest version of CocoaPods. See the [README](../README.md) in the +***The Add-to-App sample is designed to build with Flutter's `master` channel +and the latest version of CocoaPods. See the [README](../README.md) in the `experimental` directory for details.*** This directory contains a bunch of Android and iOS projects that each import @@ -16,7 +16,24 @@ a standalone Flutter module called `example_module`. ### `example_module` This is the Flutter module that'll be added to all the individual projects -in the `add2app` folder. +in the `add_to_app` folder. + +The first time you download this repo, you need to first resolve this +module's dependencies by running: + +```bash +cd example_module +flutter packages get +``` + +### `SimpleAndroidApp` + +An Android application that imports `example_module` and uses it to display +a `FlutterActivity` containing widgets from the module. This project brings +in the Flutter module's Android host wrapper as a gradle sub-module. + +To run, open the SimpleAndroidApp folder in Android Studio and press the run +button. ### `SimpleIOSExample` @@ -26,10 +43,13 @@ uses CocoaPods, so prior to running it for the first time, use this command to set up the workspace file: ```bash -cd SimpleIOSExample +cd ../SimpleIOSExample pod install ``` +Then open SimpleIOSExample/SimpleIOSExample.xcworkspace with Xcode. This +workspace will have the Flutter module linked in as a dependent CocoaPod. + ## Questions/issues If you have a general question about incorporating Flutter into an existing @@ -41,4 +61,3 @@ iOS or Android app, the best places to go are: If you run into an issue with the sample itself, please file an issue in the [main Flutter repo](https://github.com/flutter/flutter/issues). - diff --git a/experimental/add_to_app/example_module/pubspec.yaml b/experimental/add_to_app/example_module/pubspec.yaml index c981fa390..ec416bf43 100644 --- a/experimental/add_to_app/example_module/pubspec.yaml +++ b/experimental/add_to_app/example_module/pubspec.yaml @@ -1,5 +1,5 @@ name: example_module -description: A simple module used to demo Flutter's Add2App features +description: A simple module used to demo Flutter's Add-to-App features version: 1.0.0