chore: added build instructions

This commit is contained in:
maelstrom 2025-04-10 23:25:16 +02:00
parent 83c6d210e2
commit dbc02e2a4f
2 changed files with 54 additions and 0 deletions

49
BUILD.md Normal file
View file

@ -0,0 +1,49 @@
# Building on Linux
For pre-requisite packages, check [deps.txt](./deps.txt)
If your distribution does not provide ReactPhysics3D, you will have to build (and install) it yourself prior to this step
Use the following to generate the build files:
cmake -Bbuild .
Then build the project using:
cmake --build build
# Building on Windows
The project will be built using VCPKG and MSVC
## Pre-requisites
* Visual Studio 17.13.3 or higher, with MSVC v143/14.42.34438.0 or higher
* Qt 6.8.3 or higher, with MSVC toolchain
* CMake
* Git (for cloning the repo, optional)
* ReactPhysics3D prebuilt library
You will have to build and install ReactPhysics3D yourself. Check the [build instructions on ReactPhysics3D](https://www.reactphysics3d.com/documentation/index.html#building) for help
To start, clone the repository:
git clone https://git.maelstrom.dev/maelstrom/openblocks
Then, launch the *x64 Native Tools Command Prompt for VS 2022*, and cd into the directory that you cloned the project into
Once in the directory, add Qt to the `CMAKE_PREFIX_PATH` variable (for instance, if you install Qt to `C:\Qt\6.8.3`):
set CMAKE_PREFIX_PATH=C:\Qt\6.8.3\msvc2022_64
Now, generate the build files with cmake via the vcpkg preset:
cmake -Bbuild . --preset vcpkg
Then, finally, build in release mode:
cmake --build build --config Release
The compiled binaries should then be placed 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.

5
README.md Normal file
View file

@ -0,0 +1,5 @@
# Openblocks
[ Docs are work in progress! ]
For build instructions, see [BUILD.md](./BUILD.md)