Skip to content

Commit fde7a0a

Browse files
xsterRedBrogdon
authored andcommitted
small random notes (#137)
1 parent 4481391 commit fde7a0a

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

experimental/add_to_app/README.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Add-to-App Sample
22

3-
***The Add-to-App sample is designed to build with Flutter's `master` channel
4-
and the latest version of CocoaPods. See the [README](../README.md) in the
3+
***The Add-to-App sample is designed to build with Flutter's `master` channel
4+
and the latest version of CocoaPods. See the [README](../README.md) in the
55
`experimental` directory for details.***
66

77
This directory contains a bunch of Android and iOS projects that each import
@@ -16,7 +16,24 @@ a standalone Flutter module called `example_module`.
1616
### `example_module`
1717

1818
This is the Flutter module that'll be added to all the individual projects
19-
in the `add2app` folder.
19+
in the `add_to_app` folder.
20+
21+
The first time you download this repo, you need to first resolve this
22+
module's dependencies by running:
23+
24+
```bash
25+
cd example_module
26+
flutter packages get
27+
```
28+
29+
### `SimpleAndroidApp`
30+
31+
An Android application that imports `example_module` and uses it to display
32+
a `FlutterActivity` containing widgets from the module. This project brings
33+
in the Flutter module's Android host wrapper as a gradle sub-module.
34+
35+
To run, open the SimpleAndroidApp folder in Android Studio and press the run
36+
button.
2037

2138
### `SimpleIOSExample`
2239

@@ -26,10 +43,13 @@ uses CocoaPods, so prior to running it for the first time, use this command
2643
to set up the workspace file:
2744

2845
```bash
29-
cd SimpleIOSExample
46+
cd ../SimpleIOSExample
3047
pod install
3148
```
3249

50+
Then open SimpleIOSExample/SimpleIOSExample.xcworkspace with Xcode. This
51+
workspace will have the Flutter module linked in as a dependent CocoaPod.
52+
3353
## Questions/issues
3454

3555
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:
4161

4262
If you run into an issue with the sample itself, please file an issue
4363
in the [main Flutter repo](https://github.com/flutter/flutter/issues).
44-

experimental/add_to_app/example_module/pubspec.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: example_module
2-
description: A simple module used to demo Flutter's Add2App features
2+
description: A simple module used to demo Flutter's Add-to-App features
33

44
version: 1.0.0
55

0 commit comments

Comments
 (0)