aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordkhalanskyjb <52952525+dkhalanskyjb@users.noreply.github.com>2020-10-09 12:01:05 +0300
committerGitHub <noreply@github.com>2020-10-09 12:01:05 +0300
commitb82439e6b570249cfbd25622dc06cb0ec156c006 (patch)
tree9f53172b2dc5dcb03d2778227b96898dc1e92ad8 /README.md
parent20ca97ad47adc249c6211ad9d12e31f1074984d7 (diff)
downloadkotlinx.coroutines-b82439e6b570249cfbd25622dc06cb0ec156c006.tar.gz
Document problems with building coroutines-using Android projects (#2288)
Added instructions to work around #2023 Also, the answer to #2274 is now documented. Co-authored-by: Vsevolod Tolstopyatov <qwwdfsad@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4b6f99be..7f71d288 100644
--- a/README.md
+++ b/README.md
@@ -176,6 +176,17 @@ threads are handled by Android runtime.
R8 and ProGuard rules are bundled into the [`kotlinx-coroutines-android`](ui/kotlinx-coroutines-android) module.
For more details see ["Optimization" section for Android](ui/kotlinx-coroutines-android/README.md#optimization).
+#### Avoiding including the debug infrastructure in the resulting APK
+
+The `kotlinx-coroutines-core` artifact contains a resource file that is not required for the coroutines to operate
+normally and is only used by the debugger. To exclude it at no loss of functionality, add the following snippet to the
+`android` block in your gradle file for the application subproject:
+```groovy
+packagingOptions {
+ exclude "DebugProbesKt.bin"
+}
+```
+
### JS
[Kotlin/JS](https://kotlinlang.org/docs/reference/js-overview.html) version of `kotlinx.coroutines` is published as