Guides

Practical guides

These pages are sourced from the repo docs and organized around common tasks.

SC::Build

Describe builds in C++ and use SC::Build to generate projects or build directly through the native backend.

External SC::Build Bootstrap

Use SC-build launchers from an external project with a vendored, shared-checkout, or cached Sane C++ layout.

Building (Contributor)

Build the repository locally, run focused tests, reproduce issues, and validate contribution branches.

Building (User)

Add the libraries to an existing project without adopting the repository test suite or project-generation workflow.

Coding Style

Formatting, naming, error-handling, and API rules for code that should remain readable to humans and agents.

Examples

Run the example programs and use them as practical references for SC::Build, Async, Http, Plugin, and other libraries.

FAQ

Answers for standard-library mode, exceptions, RTTI, STL integration, debug visualizers, and compatibility questions.

Libraries

Browse the generated library list, dependency graph, LOC summary, and C binding groups.

Platforms

Supported, planned, and intentionally unsupported operating-system targets.

Principles

The constraints behind the libraries: readable code, explicit ownership, fast builds, strict errors, and controlled dependencies.

Single File Amalgamation

Open the generated amalgamation tool for standalone single-file headers.

Tests

Understand where tests live, how they double as examples, and how coverage is published.

Tools

Use self-contained C++ tools that compile on demand through the repository bootstrap scripts.