From 4e5447230d46dc78eadbfea944df7affbf5ba063 Mon Sep 17 00:00:00 2001
From: squidbus <175574877+squidbus@users.noreply.github.com>
Date: Mon, 2 Sep 2024 22:24:24 -0700
Subject: [PATCH] Add macOS build guide.

---
 README.md                   |  4 +++
 documents/building-macos.md | 71 +++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 documents/building-macos.md

diff --git a/README.md b/README.md
index c99142c7..f600a0b9 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,10 @@ Check the build instructions for [**Windows**](https://github.com/shadps4-emu/sh
 
 Check the build instructions for [**Linux**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-linux.md).
 
+## macOS
+
+Check the build instructions for [**macOS**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-macos.md).
+
 ## Building status
 
 <details>
diff --git a/documents/building-macos.md b/documents/building-macos.md
new file mode 100644
index 00000000..7a61f08e
--- /dev/null
+++ b/documents/building-macos.md
@@ -0,0 +1,71 @@
+<!--
+SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
+SPDX-License-Identifier: GPL-2.0-or-later
+-->
+
+## Build shadPS4 for macOS
+
+### Install the necessary tools to build shadPS4:
+
+For installing tools and library dependencies we will be using [Homebrew](https://brew.sh/).
+
+On an ARM system, we will need the native ARM Homebrew to install tools and x86_64 Homebrew to install libraries.
+
+First, install native Homebrew and tools:
+```
+# Installs native Homebrew to /opt/homebrew
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+# Adds Homebrew to your path
+echo 'eval $(/opt/homebrew/bin/brew shellenv)' >> ~/.zprofile
+eval $(/opt/homebrew/bin/brew shellenv)
+# Installs tools.
+brew install clang-format cmake
+```
+
+Next, install x86_64 Homebrew and libraries.
+
+**If you are on an ARM Mac:**
+```
+# Installs x86_64 Homebrew to /usr/local
+arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+# Installs libraries.
+arch -x86_64 /usr/local/bin/brew install molten-vk qt@6
+```
+
+**If you are on an x86_64 Mac:**
+```
+brew install molten-vk qt@6
+```
+
+If you don't need the Qt GUI you can remove `qt@6` from the last command.
+
+### Cloning and compiling:
+
+Clone the repository recursively:
+```
+git clone --recursive https://github.com/shadps4-emu/shadPS4.git
+cd shadPS4
+```
+
+Generate the build directory in the shadPS4 directory:
+```
+cmake -S . -B build/ -DCMAKE_OSX_ARCHITECTURES=x86_64
+```
+
+If you want to build the Qt GUI, add `-DENABLE_QT_GUI=ON` to the end of this command as well.
+
+Enter the directory:
+```
+cd build/
+```
+
+Use make to build the project:
+```
+cmake --build . --parallel$(sysctl -n hw.ncpu)
+```
+
+Now run the emulator:
+
+```
+./shadps4 /"PATH"/"TO"/"GAME"/"FOLDER"/eboot.bin
+```