update: script update to account for the Xcode build guard #564
Conversation
| * In the `./gradlew` command, specify the name of the shared module, for example, `:shared` or `:composeApp`. | ||
| * When you start an iOS run configuration, IntelliJ IDEA and Android Studio build the Kotlin framework dependency | ||
| before starting the Xcode build, and set the `OVERRIDE_KOTLIN_BUILD_IDE_SUPPORTED` environment variable to "YES". | ||
| The suggested shell script checks this variable and prevents the Kotlin framework from being built a second time, from Xcode. |
There was a problem hiding this comment.
| The suggested shell script checks this variable and prevents the Kotlin framework from being built a second time, from Xcode. | |
| The provided shell script checks this variable and prevents the Kotlin framework from being built a second time from Xcode. |
|
|
||
| * In the `cd` command, specify the path to the root of your Kotlin Multiplatform project, for example, `$SRCROOT/..`. | ||
| * In the `./gradlew` command, specify the name of the shared module, for example, `:shared` or `:composeApp`. | ||
| * When you start an iOS run configuration, IntelliJ IDEA and Android Studio build the Kotlin framework dependency |
There was a problem hiding this comment.
This is very minor but I think the sentence would read better if you replace "IntelliJ IDEA and Android Studio" with "the IDE". So you can eliminate the double "and" (unless it's important to specify both of them).
Also, since it's not an instruction like the previous 2 points, it doesn't need to be a list item.
There was a problem hiding this comment.
I would keep the explicit mentions of IntelliJ IDEA and Android Studio since Xcode is also an IDE, and that could be confusing
There was a problem hiding this comment.
+1 to "not a list item." If you want to keep it in the list, you can rewrite it as an action point like "Start your iOS run configuration" and move all the details to a separate paragraph
There was a problem hiding this comment.
Yeah, IDEs can be ambiguous when we jump around between Xcode and IntelliJ, I keep coming up against this and deciding that it's easier to just mention them both. It's not like there's going to be another IDE on the list any time soon.
As for the list item, agreed, moved this out.
| When you launch an iOS run configuration for a project that does not support this, | ||
| the IDE suggests a fix to set up the build guard. | ||
|
|
||
| {width=700} |
There was a problem hiding this comment.
There's no change here, but Isn't this image part of step 6? 🤔
There was a problem hiding this comment.
+1, the image definitely belongs in step 6
No description provided.