Skip to main content
Zep offers multiple installation methods to fit your project’s needs. Choose the approach that works best for you.

​
Installation Methods

Single Header

Easiest - just include one header file

CMake Library

Build and install as a system package

Submodule

Add as a Git submodule to your project

​
Method 1: Single Header Library

The simplest way to get started. Just add Zep as a submodule and include the header:
1

Add as submodule

git submodule add https://github.com/Rezonality/zep
2

Update CMakeLists.txt

Add the include directory to your CMakeLists.txt:
target_include_directories(myapp
    PRIVATE
    zep/include
)
3

Include in your code

#include "zep/zep.h"
This method requires no building of Zep - just include the header and you’re ready to go!

​
Method 2: CMake Installed Package

Build and install Zep as a system library, then link against it:
1

Clone the repository

git clone https://github.com/Rezonality/zep
cd zep
git submodule update --init
2

Run prebuild script

./prebuild.sh
3

Build and install

mkdir build
cd build
cmake -G "Unix Makefiles" -DBUILD_IMGUI=0 -DBUILD_TESTS=0 -DBUILD_DEMOS=0 ..
cmake --build . --target install
4

Link in your project

Add to your CMakeLists.txt:
find_package(Zep REQUIRED)
target_link_libraries(MYPROJECT PRIVATE Zep::Zep)

​
Method 3: Direct Source Integration

Copy the source files directly into your project:
1

Copy source files

Copy the contents of src/ and include/ directories into your project.
2

Add to build system

Add the .cpp files to your build system and include paths as needed.

​
CMake Build Options

When building Zep, you can configure these options:
OptionDefaultDescription
BUILD_IMGUIOFFBuild ImGui rendering support
BUILD_QTOFFBuild Qt rendering support
BUILD_DEMOSONBuild demo applications
BUILD_TESTSONBuild unit tests
ZEP_FEATURE_CPP_FILE_SYSTEMONEnable C++ filesystem support
For embedding in your application, set BUILD_IMGUI=0, BUILD_TESTS=0, and BUILD_DEMOS=0 to build only the core library.

​
Platform-Specific Notes

​
Linux

Install required packages: 
sudo apt install cmake git

​
macOS

Install via Homebrew: 
brew install cmake git

​
Windows

Ensure you have:
  • Visual Studio 2017 or later
  • CMake 3.2 or later
  • Git for Windows
On Windows, if building demos with Qt, set the QT_INSTALL_LOCATION environment variable:
set QT_INSTALL_LOCATION=C:\Qt\5.10.0\msvc2017_64

​
Verifying Installation

To verify your installation, try building a simple test: 
#include "zep/editor.h"
#include <iostream>

int main() {
    std::cout << "Zep installed successfully!" << std::endl;
    return 0;
}

​
Next Steps

Quick Start Guide

Learn how to create your first Zep editor with a minimal ImGui example

Build docs developers (and LLMs) love

Get started for freeTalk to us