Skip to content

Commit 7aafe5e

Browse files
authored
Add Android Studio configuration instructions to README (#819)
Includes VM options for large file indexing and JDK troubleshooting.
1 parent 08c04d7 commit 7aafe5e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Given the multi-platform nature of this project, the development environment wil
1818
| [Android SDK](https://developer.android.com/tools) | Android |
1919
| [Docker](https://www.docker.com/) (for integration tests) | Core + Android |
2020

21+
See [Android Studio Configuration](#android-studio-configuration) for required IDE setup.
22+
2123
### Swift
2224

2325
| Dependency | Platform |
@@ -53,3 +55,20 @@ This project has several test suites. Integration tests require Docker, and you
5355
| Kotlin Integration Tests | `cd native/kotlin && ./gradlew :api:kotlin:integrationTest` | `make test-kotlin-integration` |
5456
| Swift Unit Tests | `swift test` | `make test-swift-linux-in-docker` |
5557

58+
#### Android Studio Configuration
59+
60+
This project generates large Kotlin files that exceed Android Studio's default indexing limits. Add the following VM option to enable proper code indexing:
61+
62+
```
63+
-Didea.max.intellisense.filesize=999999
64+
```
65+
66+
To add this:
67+
1. Go to `Help` > `Edit Custom VM Options`
68+
2. Add the line to the `studio.vmoptions` file
69+
3. Invalidate caches and restart Android Studio
70+
71+
This setting helps resolve indexing issues with large generated files like `wp_api.kt`.
72+
73+
**Troubleshooting:** If Android Studio cannot find `cargo`, it may be using its internal JDK instead of the system one. To fix this, [switch Android Studio to use your system JDK](https://stackoverflow.com/questions/30631286/how-to-specify-the-jdk-version-in-android-studio).
74+

0 commit comments

Comments
 (0)