Skip to content

Commit 76fbe31

Browse files
authored
[Impeller] Update the readme to reflect current guidance on how to try Impeller. (flutter#52135)
1 parent 20f8d5f commit 76fbe31

1 file changed

Lines changed: 24 additions & 3 deletions

File tree

impeller/README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,23 +188,44 @@ macOS Desktop. This flag can be specified to `flutter run`.
188188
If the application needs to be launched with Impeller enabled without using the
189189
Flutter tool, follow the platform specific steps below.
190190

191-
### iOS and macOS Desktop
191+
### iOS
192+
193+
Flutter enables Impeller by **default** on iOS.
194+
195+
> [!CAUTION]
196+
> The ability to disable Impeller is going to go away in a future release. Please [file
197+
> an issue](https://github.com/flutter/flutter/issues/new/choose) if you need to do this
198+
> in your application. A warning will be displayed on application launch if you opt-out.
199+
200+
To **disable** Impeller on iOS, update your `Info.plist` file to add the following
201+
under the top-level `<dict>` tag:
192202

193-
To your `Info.plist` file, add under the top-level `<dict>` tag:
194203
```
195204
<key>FLTEnableImpeller</key>
196-
<true/>
205+
<false/>
197206
```
198207

199208
### Android
200209

210+
Impeller is in preview on Android.
211+
201212
To your `AndroidManifest.xml` file, add under the `<application>` tag:
202213
```
203214
<meta-data
204215
android:name="io.flutter.embedding.android.EnableImpeller"
205216
android:value="true" />
206217
```
207218

219+
### macOS Desktop
220+
221+
Impeller is in preview on macOS Desktop.
222+
223+
To your `Info.plist` file, add under the top-level `<dict>` tag:
224+
```
225+
<key>FLTEnableImpeller</key>
226+
<true/>
227+
```
228+
208229
## Documentation, References, and Additional Reading
209230

210231
* [Frequently Asked Questions](docs/faq.md)

0 commit comments

Comments
 (0)