maelstrom/openblocks
1
1
Fork 0
Code Issues 1 Pull requests Projects Releases 3 Packages Wiki Activity Actions

chore: updated build instructions

Browse source
This commit is contained in:
maelstrom 2025-07-24 01:52:40 +02:00
parent 471b2472e3
commit 8d5fb3b2c6
1 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
BUILD.md
View file

@ -1,20 +1,27 @@
# Building on Linux
For pre-requisite packages, check [deps.txt](./deps.txt)
You will need to install Qt beforehand. All other packages will automatically be obtained through CPM.
If your distribution does not provide ReactPhysics3D, you will have to build (and install) it yourself prior to this step
ccache is highly recommended.
Use the following to generate the build files:
cmake -Bbuild .
> [!NOTE]
> Add -DCMAKE_BUILD_TYPE=Release to produce a release build
Then build the project using:
cmake --build build
The compiled binaries should then be located in `./build/bin/` and should be ready for redistribution without any further work.
If any of the compilation steps fail, or the binaries fail to execute, please create an issue so that this can be corrected.
# Building on Windows
The project will be built using VCPKG and MSVC
The process is very similar on Windows
## Pre-requisites
@ -34,16 +41,18 @@ Once in the directory, add Qt to the `CMAKE_PREFIX_PATH` variable (for instance,
set CMAKE_PREFIX_PATH=C:\Qt\6.8.3\msvc2022_64
Now, generate the build files with cmake via the vcpkg preset:
Now, generate the build files:
cmake -Bbuild . --preset vcpkg
cmake -Bbuild .
Then, finally, build in release mode\*:
Then, finally build:
cmake --build build --config Release
cmake --build build
The compiled binaries should then be placed in `./build/bin/` and should be ready for redistribution without any further work.
> [!NOTE]
> To build in release mode, add -DCMAKE_BUILD_TYPE=Release to the configure (first) command,
> and add --config Release to the build (second) command
If any of the compilation steps fail, or the binaries fail to execute, please create an issue so that this can be corrected.
The compiled binaries should then be located in `./build/bin/[Debug|Release]` and should be ready for redistribution without any further work.
\* Release mode is necessary as debug mode copies DLLs that are not linked to the output binary
If any of the compilation steps fail, or the binaries fail to execute, please create an issue so that this can be corrected.