Skip to content

Commit

Permalink
[en] update description of desugaring
Browse files Browse the repository at this point in the history
  • Loading branch information
Rosemoe committed Feb 19, 2024
1 parent 42113df commit 1d211fb
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ repositories {

If you use `language-textmate` module in your project, and want to run the application on devices under Android 13 (API 33), you **must** enable [Core Library Desugaring](https://developer.android.google.cn/studio/write/java8-support#library-desugaring) to avoid compatibility issues. Otherwise, you can go on to next section.

To enable the desugaring, follow the instructions below to setup your **application module**.
To enable the desugaring, follow the instructions below to setup your **application module**. Note that the following instructions are for AGP 7.4.0 or above.

* Add Desugaring Dependency
::: code-group
Expand Down Expand Up @@ -192,6 +192,14 @@ android {

:::

::: warning BE CAUTIOUS
When desugaring is enabled, you should build the APK in Android Studio by:
* Build from menu `Build` | `Build Bundle(s) / APK(s)` | `Build APK(s)`
* Or, run Gradle task `assemble<Variant>`. For example, execute `assembleDebug` for your `debug` variant.

Android Studio internally tries to speed up the desugaring process when you run the application by clicking the `Run` button (or `Shift+F10`). It will generate a device specific APK, and the result APK may not work properly on other devices.
:::

## Create the Widget

Please ensure you have included `editor` module in your project, and then sync your project with Gradle files successfully.
Expand Down

0 comments on commit 1d211fb

Please sign in to comment.