Skip to content

help.md

Latest commit

 

History

History
43 lines (35 loc) · 1.59 KB

help.md

File metadata and controls

43 lines (35 loc) · 1.59 KB
Raw

How to configure and build project

Requirements:

  • Git
  • Cmake 3.0+
  • Compiler:
    • GCC 8+ (Requirement may be updated in the future)
    • Clang 6+ (Requirement may be updated in the future)
    • MSVC 19.20+ (Requirement may be updated in the future)
  • Install all git submodules:
    • glfw
    • imgui
    • glm
  • Ninja or alternative (msbuild etc.)

Default cmake script:

cd /path/to/project/
cmake --no-warn-unused-cli -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE -DCMAKE_BUILD_TYPE:STRING=Release "-H./" "-B./.cmake" -G Ninja

Debug cmake script:

cd /path/to/project/
cmake --no-warn-unused-cli -DRENDER_BUILD_SAMPLES=ON -DRENDER_WITH_*=ON -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE -DCMAKE_BUILD_TYPE:STRING=Debug "-H./" "-B./.cmake" -G Ninja

Build script:

cmake --build .cmake --config Your_Configuration --target all

Options:

Option Description Cmake Argument
RENDER_BUILD_SAMPLES If this option is enabled, sample projects will be included in the build -DRENDER_BUILD_SAMPLES=ON
RENDER_BUILD_DISABLE_DLL_WARNINGS If this option is enabled, C4251 warning will be disabled (dll warning) -DRENDER_BUILD_DISABLE_DLL_WARNINGS=ON
RENDER_WITH_OGL This option determines whether the OpenGL renderer is present in the build -DRENDER_WITH_OGL=ON
RENDER_WITH_DX11 This option determines whether the DirectX 11 renderer is present in the build -DRENDER_WITH_DX11=ON
RENDER_WITH_DX12 This option determines whether the DirectX 12 renderer is present in the build -DRENDER_WITH_DX12=ON