Add a Getting Started document for the Swift Android SDK #985
Conversation
marcprux
requested review from
0xTim,
alexandersandberg,
davelester,
daveverwer,
dempseyatgithub,
federicobucchi,
kaishin,
shahmishal and
timsneath
as code owners
|
Moving this to draft until we have the official release of Swift Android SDK on swift.org |
|
Looks good, only wonder if we should add more info on next steps and upcoming work at the end, say linking to swift-java tools. |
| The easiest and recommended way to manage host toolchains on macOS and Linux is to use the [swiftly](https://www.swift.org/swiftly/documentation/swiftly/getting-started) command. Once that has been setup, you can install the host toolchain with: | ||
|
|
||
| ```console | ||
| $ swiftly install 6.2 |
There was a problem hiding this comment.
Sorry, but since we are only doing the trunk snapshots initially, could you change all these to that? We can change it to this once we have a release SDK available, which we won't initially.
There was a problem hiding this comment.
Happy to update this, but we'll need to know which nightly to recommend installing, which we won't know until we have one ready to publish. I expect that we'll just replace all "6.2" with "swift-DEVELOPMENT-SNAPSHOT-2025-10-02" (or whatever) when we are ready to go.
Or are there other changes that need to be made to update the instructions for the snapshots?
There was a problem hiding this comment.
Good point, we do need the date ready, my mistake. 🫤
I'll check if there's anything else.
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: Max Desiatov <[email protected]>
Co-authored-by: Mishal Shah <[email protected]>
Co-authored-by: Mishal Shah <[email protected]>
|
OK, I think I've covered all the reviews and feedback, so I'll take this out of draft. Feel free to do a final pass and let me know if there are more changes that need to be made. But note that I imagine this will be more of a "living document" than the blog announcement, and we will be making improvements and changes over time (especially as we get more current SDK snapshots published), so we can always add more details and clarifications over time. |
documentation/articles/swift-sdk-for-android-getting-started.md
Outdated
Show resolved
Hide resolved
documentation/articles/swift-sdk-for-android-getting-started.md
Outdated
Show resolved
Hide resolved
…d language to link NDK
…d package init language
|
Alright, @shahmishal, this is ready, let me know if you see any last changes to be added and I can add them. |
documentation/articles/swift-sdk-for-android-getting-started.md
Outdated
Show resolved
Hide resolved
6 participants
Motivation:
This article provides instructions for installing and setting up the Android SDK (swiftlang/swift#80788). It describes the process for the SDK bundle that is created with swiftlang/swift-docker#467.
The structure of the article largely follows the format of the Static Linux Getting Started guide (#686).
Modifications:
Add a documentation/articles/swift-android-getting-started.md article and updates to the articles index and authors list.
Result:
There will now be a new article titled "Getting Started with the Swift Android SDK".