Skip to content
This repository has been archived by the owner on Dec 27, 2020. It is now read-only.

Latest commit

 

History

History
58 lines (39 loc) · 1.4 KB

contributing.md

File metadata and controls

58 lines (39 loc) · 1.4 KB

Contributing to Nova Renderer

We are always welcome to new contributers. Please read the following before contributing.

Contact Us

If you want to contribute, we recommend that you drop us a line over on Discord so we can help onboard you properly. However, we welcome pull requests from anyone, talking to us beforehand is not required.

Compiling

Nova is built the same way most cmake projects are built. However, git submodules need to be cloned:

git submodule update --init --recursive

From there, standard cmake build:

Windows

# Generate Visual Studio Project
cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 16 2019" -Wno-dev
# Build from command line, or open into Visual Studio
cmake --build build

Unix

If you have the ninja build tool, it is the recommended way of building.

# Generate Visual Studio Project
cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug -GNinja -Wno-dev
# Build from command line, or open into Visual Studio
ninja -C build

If you don't have ninja, use regular make.

# Generate Ninja
cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug -Wno-dev
# Build from command line
make -C build -j$(nproc)

Principles

Rules

These must be followed for your PR to be accepted.