Internal documentation — Work in progress

This page has not been confirmed as accurate or approved for publication. Current documentation version: 0.1.0-internal.1.

Installation

Prerequisites

Development is currently documented for Git Bash on Windows with an MSYS2 UCRT64 C++ toolchain. The build uses C++23 and expects g++, make, bash, and cygpath.

From the repository root:

bash scripts/test.sh

That script adds the UCRT64 and Unix tool directories to PATH, creates a repository-local temporary directory, performs a clean build, prints the Git-derived version, runs tokenizer self-tests, and invokes --version.

To build without running the test script:

make all

The resulting executable is bin/sagan.

For documentation tooling, install Python 3 and run:

bash scripts/docs.sh setup

The documentation virtual environment and generated site live under the ignored build/ directory.