From ca964d85dd5522f1e1b27d43ad868a98be1f2b11 Mon Sep 17 00:00:00 2001
From: Hyper <34012267+hyperbx@users.noreply.github.com>
Date: Mon, 24 Feb 2025 08:36:10 +0000
Subject: [PATCH] Update BUILDING.md

---
 BUILDING.md | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/BUILDING.md b/BUILDING.md
index 0f76f32b..79698fb0 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,12 +1,29 @@
 # Building
+
+## Windows
+### Pre-requisites
+- Git
+- Visual Studio 2022
+- CMake
+- clang
+
+> [!NOTE]
+> The required versions of CMake and clang can be obtained via Visual Studio Installer as part of the **Desktop development with C++** workload.
+
+### Instructions
 1. Clone **UnleashedRecomp** with submodules (or run `update_submodules.bat` to ensure submodules are pulled).
 ```
 git clone --recurse-submodules https://github.com/hedge-dev/UnleashedRecomp.git
 ```
 2. Place `default.xex` and `default.xexp` in `./UnleashedRecompLib/private/`.
 3. Decompress `shader.ar` and place the resulting file in `./UnleashedRecompLib/private/`.
-4. Open the repository directory in Visual Studio 2022 and wait for CMake generation to complete. If you don't plan to debug, switch to the `x64-Clang-Release` configuration.
-5. Under Solution Explorer, right-click and choose "Switch to CMake Targets View".
-6. Right-click the **UnleashedRecomp** project and choose "Set as Startup Item", then choose "Add Debug Configuration".
-7. Add a `currentDir` property to the first element under `configurations` in the generated JSON and set its value to the path to your game directory (where root is the directory containing `dlc`, `game`, `save`, `update`, etc).
-8. Run or debug **UnleashedRecomp**. The initial compilation might take a while to complete due to code and shader recompilation.
+4. Open the repository directory in Visual Studio 2022 and wait for CMake generation to complete. If you don't plan to debug, switch to the `Release` configuration.
+> [!NOTE]
+> If you need a Release-performant build and want to iterate on development without debugging, it is highly recommended that you use the `RelWithDebInfo` configuration for faster compile times.
+5. Under Solution Explorer, right-click and choose **Switch to CMake Targets View**.
+6. Right-click the **UnleashedRecomp** project and choose **Set as Startup Item**, then choose **Add Debug Configuration**.
+7. Add a `currentDir` property to the first element under `configurations` in the generated JSON and set its value to the path to your game directory (where root is the directory containing `dlc`, `game`, `update`, etc).
+8. Start **UnleashedRecomp**. The initial compilation may take a while to complete due to code and shader recompilation.
+
+## Linux
+TODO