Skip to content

Commit eb44590

Browse files
committed
Add swiftly documentation
1 parent 54cee28 commit eb44590

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

userdocs/userdocs.docc/supported-toolchains.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,16 @@ Feature | Minimum Toolchain Required
1616
------------------------ | -------------------------------------
1717
lldb-dap debugging | 6.0
1818

19+
## Swiftly Support
20+
21+
The extension supports toolchains managed by [swiftly](https://github.com/swiftlang/swiftly), the Swift toolchain installer and manager. For instructions on installing swiftly see the [installation instructions on Swift.org](https://www.swift.org/install).
22+
23+
You can choose a swiftly managed toolchain to use from the `> Swift: Select Toolchain` menu.
24+
25+
If you do `swiftly use` on the command line you must restart VS Code or do `> Developer: Reload Window` in order for the VS Code Swift extension to start using the new toolchain.
26+
27+
### `.swift-version` Support
28+
29+
Swiftly can use a special `.swift-version` file in the root of your package so that you can share your toolchain preference with the rest of your team. The VS Code Swift extension respects this file if it exists and will use the toolchain specified within it to build and test your package.
30+
31+
For more information on the `.swift-version` file see swiftly's documentation on [sharing recommended toolchain versions](https://swiftpackageindex.com/swiftlang/swiftly/main/documentation/swiftlydocs/use-toolchains#Sharing-recommended-toolchain-versions).

0 commit comments

Comments
 (0)