Skip to content

Commit eae537f

Browse files
Add missing macOS dependencies to Brewfile, update README.md (#231)
I recently did a clean install of macOS on an Intel MacBook and tried to run the SDK generator on it. I found that a few dependencies were missing from the `Brewfile`, especially when trying to create a Swift SDK for 5.10.1, which requires LLVM to be compiled for the host to include in the SDK. I've added these dependencies to the Brewfile and also updated the README.md to show what each one is for. --------- Co-authored-by: Max Desiatov <[email protected]>
1 parent 7e05186 commit eae537f

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

Brewfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
brew 'xz'
2+
brew 'zstd'
3+
brew 'cmake'
4+
brew 'ninja'

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,22 @@ After that, verify that the `experimental-sdk` command is available:
2424
swift experimental-sdk list
2525
```
2626

27-
The output will either state that no Swift SDKs are available, or produce a list of those you previously had
28-
installed, in case you've used the `swift experimental-sdk install` command before.
27+
The output will either state that no Swift SDKs are available, or produce a list of those you previously had installed, in case you've used the `swift experimental-sdk install` command before.
2928

3029
### macOS Requirements
3130

32-
The generator depends on the `xz` utility for more efficient downloading of package lists for Ubuntu. This is optional, but can be installed via the included `Brewfile`:
31+
The generator depends on the following dependencies to be installed on macOS:
32+
33+
- `xz`: used for more efficient downloading of package lists for Ubuntu. If `xz` is not found, the generator will fallback on `gzip`.
34+
- `cmake` and `ninja`: required for building LLVM native for versions of Swift before 6.0. _*NOTE: if you're building the Swift toolchain outside of Swift SDK Generator, you'll have to uninstall Homebrew CMake or remove it from your `PATH` before invoking toolchain's `build-script` due to [swiftlang/swift#83060](https://github.com/swiftlang/swift/pull/83060).*_
35+
- `zstd`: required to decompress certain downloaded artifacts that use [Zstandard](https://github.com/facebook/zstd) compression.
36+
37+
These dependencies can be installed from the `Brewfile`:
3338

3439
```bash
3540
brew bundle install
3641
```
3742

38-
If `xz` is not found, the generator will fallback on `gzip`.
39-
4043
## Supported platforms and minimum versions
4144

4245
macOS as a host platform and Linux as both host and target platforms are supported by the generator.

0 commit comments

Comments
 (0)