Skip to content

Commit 986b494

Browse files
authored
Update GettingStarted with note on M1 Macs
Running the wrong version of Python will result in the build failing a long way into the process, and giving an unrelated error. This note can save new contributors several hours of frustrating troubleshooting.
1 parent b325f2a commit 986b494

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,15 @@ toolchain as a one-off, there are a couple of differences:
138138
The required version of Xcode changes frequently and is often a beta release.
139139
Check this document or the host information on <https://ci.swift.org> for the
140140
current required version.
141-
2. Install [CMake][], [Ninja][] and [Sccache][]:
141+
1. **If you are running on Apple Silicon hardware** (M1, M2, etc):
142+
Ensure you have the native arm64 build of Python configured.
143+
Run `file $(which python3)`; it should print "arm64".
144+
If it prints "x86_64", you are running Python in compatibility mode (Rosetta),
145+
and will need to ensure the native version of Python is installed and
146+
configured in your PATH.
147+
Running `uname -m` should also print "arm64", otherwise your terminal is also
148+
running in Rosetta mode.
149+
1. Install [CMake][], [Ninja][] and [Sccache][]:
142150
- Via [Homebrew][] (recommended):
143151
```sh
144152
brew install cmake ninja sccache

0 commit comments

Comments
 (0)