Skip to content

Installation

Currently, Catalyst must be built from source.

Prerequisites

  • CMake: 3.20 or newer
  • C++ Compiler: Clang 16+ or GCC 13+ (Must support C++23)
  • Build Backend: CBE (recommended), Ninja, or GNU Make
  • Git

Building from Source

  1. Clone the repository:
git clone https://github.com/CatalystCPP/catalyst-build-system.git
cd catalyst
  1. Build the Bootstrap version using CMake:
git checkout tags/1.0.0
cmake -B build-bootstrap -S . -DCMAKE_BUILD_TYPE=Release
cmake --build build-bootstrap --config Release
  1. Build Catalyst:
git checkout dev-1.1.0
mkdir build
./build-bootstrap/catalyst build

Verifying Installation

Run the following command to verify that Catalyst is installed correctly:

build/catalyst -v # should be 1.1.0

Next Steps