mirror of
https://github.com/RGBCube/serenity
synced 2025-10-31 17:42:43 +00:00
65440f9262
This PR includes information that highlights the importance of updating Xcode on MacOS. I ran into problems building serenity on MacOS because I had Xcode installed but not updated in a while. This triggered seemingly unrelated errors that were easily solved by updating Xcode.
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# Setting up a development environment on macOS
|
|
|
|
# Prerequisites
|
|
|
|
This installation guide assumes that you have [Homebrew](https://brew.sh) and Xcode installed. You need to open Xcode at least once for it to install the required tools.
|
|
|
|
Before you build, you must set your command line tools to Xcode's tools instead of the ones installed via Homebrew:
|
|
```console
|
|
sudo xcode-select --switch /Applications/Xcode.app
|
|
```
|
|
|
|
Make sure you also have all the following dependencies installed:
|
|
|
|
```console
|
|
# core
|
|
brew install coreutils e2fsprogs qemu bash gcc@11 imagemagick ninja cmake ccache rsync zstd
|
|
|
|
# (option 1) fuse + ext2
|
|
brew install m4 autoconf automake libtool
|
|
brew install --cask macfuse
|
|
Toolchain/BuildFuseExt2.sh
|
|
|
|
# (option 2) genext2fs
|
|
brew install genext2fs
|
|
```
|
|
|
|
If you're building on M1 Mac and have Homebrew installed in both Rosetta and native environments,
|
|
you have to make sure that required packages are installed only in one of the environments. Otherwise,
|
|
these installations can conflict during the build process, which is manifested in hard to diagnose issues.
|
|
Building on M1 natively without Rosetta is recommended, as the build process should be faster without Rosetta
|
|
overhead.
|
|
|
|
Notes:
|
|
|
|
- Installing macfuse for the first time requires enabling its system extension in System Preferences and then restarting
|
|
your machine. The output from installing macfuse with brew says this, but it's easy to miss.
|
|
- It's important to make sure that Xcode is not only installed but also accordingly updated, otherwise CMake will run into incompatibilities with GCC.
|