From a69603997d0900bec9ede57009393c40f43de98c Mon Sep 17 00:00:00 2001
From: Magnus Norddahl <dpjudas@users.noreply.github.com>
Date: Tue, 2 Jul 2024 14:36:50 +0200
Subject: [PATCH] Move the build guide into README.md

---
 README.md       | 36 ++++++++++++++++++++++++++++++++++++
 build-guide.txt | 34 ----------------------------------
 2 files changed, 36 insertions(+), 34 deletions(-)
 delete mode 100644 build-guide.txt

diff --git a/README.md b/README.md
index a0ea1d01c..539f09518 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,39 @@ Visit our [website](https://vkdoom.org) for more details.
 
 ### Licensed under the GPL v3
 ##### https://www.gnu.org/licenses/quick-guide-gplv3.en.html
+
+### Build Guide
+
+For Windows, you need the latest version of Visual Studio, Windows SDK, Git, and CMake to build VkDoom.
+
+For Linux, you need the following:
+* libsdl2-dev
+* libopenal-dev
+* libvpx-dev
+* git
+* cmake
+
+For Mac, I recommend you use the following project, as it contains all the dependencies and makes building easy:
+* https://github.com/ZDoom/zdoom-macos-deps
+
+After you have the packages installed, cd into your projects dir, and do the following to clone:
+* git clone https://github.com/dpjudas/VkDoom
+
+Afterwards, cd into it
+* cd VkDoom
+
+Make a build folder, then cd into it
+* mkdir build
+* cd build
+
+For Windows, run the following to prepare your build environment and the second command will build:
+* cmake -A x64 ..
+* cmake --build . --config Release -- -maxcpucount
+(replace x64 with ARM64 if you're building on ARM64)
+
+For Linux, run the following to prepare your build environment and the second command will build:
+* cmake .. -DCMAKE_BUILD_TYPE=Release
+* make -j $(nproc)
+
+For Mac, if you're using zdoom-macos-deps, simply cd into it and type the following:
+* ./build.py --target vkdoom
diff --git a/build-guide.txt b/build-guide.txt
deleted file mode 100644
index c6228ea23..000000000
--- a/build-guide.txt
+++ /dev/null
@@ -1,34 +0,0 @@
-For Windows, you need the latest version of Visual Studio, Windows SDK, Git, and CMake to build VkDoom.
-
-For Linux, you need the following:
-* libsdl2-dev
-* libopenal-dev
-* libvpx-dev
-* git
-* cmake
-
-For Mac, I recommend you use the following project, as it contains all the dependencies and makes building easy:
-* https://github.com/ZDoom/zdoom-macos-deps
-
-
-After you have the packages installed, cd into your projects dir, and do the following to clone:
-* git clone https://github.com/dpjudas/VkDoom
-
-Afterwards, cd into it
-* cd VkDoom
-
-Make a build folder, then cd into it
-* mkdir build
-* cd build
-
-For Windows, run the following to prepare your build environment and the second command will build:
-* cmake -A x64 ..
-* cmake --build . --config Release -- -maxcpucount
-(replace x64 with ARM64 if you're building on ARM64)
-
-For Linux, run the following to prepare your build environment and the second command will build:
-* cmake .. -DCMAKE_BUILD_TYPE=Release
-* make -j $(nproc)
-
-For Mac, if you're using zdoom-macos-deps, simply cd into it and type the following:
-* ./build.py --target vkdoom