You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -86,27 +86,28 @@ Finally, add `import AsyncAlgorithms` to your source code.
86
86
87
87
## Getting Started
88
88
89
+
⚠️ Please note that this package currently requires a recent [Swift Trunk Development toolchain](https://www.swift.org/download/#trunk-development-main). More information on how to use custom toolchains with Xcode can be viewed [here](https://developer.apple.com/library/archive/documentation/ToolsLanguages/Conceptual/Xcode_Overview/AlternativeToolchains.html).
90
+
89
91
### Building/Testing Using Xcode on macOS
90
92
91
-
1. Open the `swift-async-algorithms` package directory in Xcode
92
-
2. Build or Test in Xcode as normal
93
-
94
-
### Building/Testing Using Swift Package Manager
93
+
1. Download the most recent development Xcode toolchain.
94
+
2. Install the package
95
+
4. Select the development toolchain in Xcode
96
+
4. Open the `swift-async-algorithms` package directory in Xcode
97
+
5. Build or Test in Xcode as normal
95
98
96
-
1. In the `swift-async-algorithms` directory run `swift build` or `swift test` accordingly
99
+
⚠️ Note: `swift test` does not currently work properly with custom toolchains for this package.
97
100
98
101
### Building/Testing on Linux
99
102
100
-
1. Download the most recent toolchain for your Linux distribution
103
+
1. Download the most recent development toolchain for your Linux distribution
101
104
2. Decompress the archive to a path in which the `swift` executable is in the binary search path environment variable (`$PATH`)
102
105
3. In the `swift-async-algorithms` directory run `swift build` or `swift test` accordingly
103
106
104
107
## Source Stability
105
108
106
109
The Swift Async Algorithms package has a goal of being source stable as soon as possible; version numbers will follow [Semantic Versioning](https://semver.org/). Source breaking changes to public API can only land in a new major version.
107
110
108
-
Before the version 1.0 the `swift-async-algorithms` package will not be source or ABI stable. Particularly the shims associated with `Clock`, `Instant` and `Duration` are present just to provide backwards compatability to older toolchains. As soon as this is available widely the shims will be removed; which will be an ABI breaking change.
109
-
110
111
The public API of version 1.0 of the `swift-async-algorithms` package will consist of non-underscored declarations that are marked `public` in the `AsyncAlgorithms` module. Interfaces that aren't part of the public API may continue to change in any release, including patch releases.
111
112
112
113
Future minor versions of the package may introduce changes to these rules as needed.
0 commit comments