novus/BUILDING.md

Building Novus

Currently the only way to build Novus is manually.

Manual

Dependencies

• Linux
  • Windows, macOS and other systems may work but are currently unsupported. Patches are accepted to fix any problems with those OSes though.
• CMake 3.25 or later
• Qt 6.6 or later
• KDE Frameworks 6
• Rust
• Corrosion

Getting source code

Novus has git submodules that must be cloned alongside the repository, so make sure to pass the --recursive flag:

$ git clone --recursive https://github.com/redstrate/Novus.git

If you missed it, it's possible to initialize the submodules afterward:

$ git submodule update --init --recursive

Configuring

To configure, run cmake in the source directory:

$ cd Novus
$ cmake -S . -B build

This command will create a new build directory and configure the source directory (.). If you want to enable more options, pass them now:

$ cmake -S . -B build -DENABLE_SOMETHING=ON

Building

Now begin building the project:

$ cmake --build build

If the build was successful, the tool binaries will be found in ./build/bin.