Building zelph¶
You do not need to build zelph to use it. The Quick Start Guide includes prebuilt binaries for Linux, macOS and Windows; build from source only when you want to change the engine, and see Contributing for what a change has to bring with it.
You need:
- C++ compiler (supporting at least C++20)
- CMake 3.25.2+
- Git
Build Instructions¶
-
Clone the repository with all submodules:
git clone --recurse-submodules https://github.com/acrion/zelph.git -
Configure the build (Release mode):
cmake -D CMAKE_BUILD_TYPE=Release -B build . -
Build the project (for MSVC, add
--config Release):cmake --build build
Verifying the Build¶
Test your installation by running the CLI:
./build/bin/zelph
or
./build/bin/zelph stdlib/examples/english.zph