Skip to content

Commit a8875a7

Browse files
Add more info about macOS dependencies to README.md
1 parent 0d4d44f commit a8875a7

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

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.
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)