OrdinaryMagician/vkdoom_m
OrdinaryMagician/vkdoom_m
1
Fork 0
Code Activity

Move the build guide into README.md

Browse source
This commit is contained in:
Magnus Norddahl 2024-07-02 14:36:50 +02:00
commit a69603997d
2 changed files with 36 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -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

34
build-guide.txt
View file

@ -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