From 820ea19ac0ff54e691e24b8805e5fce373c43699 Mon Sep 17 00:00:00 2001
From: Crimson-Hawk <crimson.hawk@suyu.dev>
Date: Sat, 20 Apr 2024 17:00:32 +0800
Subject: [PATCH] update macos guide with xcode build

---
 Building-for-macOS.md | 52 ++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 47 insertions(+), 5 deletions(-)

diff --git a/Building-for-macOS.md b/Building-for-macOS.md
index 93c1c54..65a99b2 100644
--- a/Building-for-macOS.md
+++ b/Building-for-macOS.md
@@ -1,6 +1,8 @@
 Please note this article is intended for development, and suyu on macOS is not currently ready for regular use.
 
 This article was written for developers. suyu support for macOS is not ready for casual use.
+
+## Method I: ninja
 ---
 If you are compiling on Intel Mac or are using a Rosetta Homebrew installation, you must replace all references of `/opt/homebrew` to `/usr/local`.
 
@@ -14,8 +16,6 @@ Clone the repo
 git clone --recursive https://git.suyu.dev/suyu/suyu.git
 
 cd suyu
-
-git submodule update --init --recursive
 ```
 
 Build for release
@@ -41,8 +41,50 @@ cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -Dsuyu_USE_BUNDLED_VCPKG=OFF
 ninja
 ```
 
-- TODO: use newer vcpkg. This fixes the boost context library, and allows using the web service
-- TODO: figure out what's up with libusb
+Run the output:
+```
+bin/suyu.app/Contents/MacOS/suyu
+```
+
+## Method II: Xcode
+
+---
+If you are compiling on Intel Mac or are using a Rosetta Homebrew installation, you must replace all references of `/opt/homebrew` to `/usr/local`.
+
+Install dependencies from Homebrew:
+```sh
+brew install autoconf automake boost ccache ffmpeg fmt glslang hidapi libtool libusb lz4 ninja nlohmann-json openssl pkg-config qt@5 sdl2 speexdsp zlib zlib zstd cmake Catch2 molten-vk vulkan-loader
+```
+
+Clone the repo
+```sh
+git clone --recursive https://git.suyu.dev/suyu/suyu.git
+
+cd suyu
+```
+
+Build for release
+```sh
+mkdir build && cd build
+
+export Qt5_DIR="/opt/homebrew/opt/qt@5/lib/cmake"
+
+export LIBVULKAN_PATH=/opt/homebrew/lib/libvulkan.dylib
+
+cmake .. -GXcode -DCMAKE_BUILD_TYPE=RelWithDebInfo -DSUYU_USE_BUNDLED_VCPKG=OFF -DSUYU_TESTS=OFF -DENABLE_WEB_SERVICE=ON -DENABLE_LIBUSB=OFF -DCLANG_FORMAT=ON -DSDL2_DISABLE_INSTALL=ON -DSDL_ALTIVEC=ON
+
+xcodebuild build -project suyu.xcodeproj -scheme "suyu" -configuration "RelWithDebInfo"
+```
+
+You may also want to include support for Discord Rich Presence by adding `-DUSE_DISCORD_PRESENCE=ON` after `cmake ..`
+
+Build with debug symbols (vcpkg is not currently used due to broken boost-context library):
+```sh
+mkdir build && cd build
+export Qt5_DIR="/opt/homebrew/opt/qt@5/lib/cmake"
+cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -Dsuyu_USE_BUNDLED_VCPKG=OFF -Dsuyu_TESTS=OFF -DENABLE_WEB_SERVICE=OFF -DENABLE_LIBUSB=OFF
+ninja
+```
 
 Run the output:
 ```
@@ -60,4 +102,4 @@ Run with Vulkan loader path:
 ```sh
 export LIBVULKAN_PATH=/opt/homebrew/lib/libvulkan.dylib
 bin/suyu.app/Contents/MacOS/suyu
-```
\ No newline at end of file
+```