Skip to content

About

FASTENgine - Fast Engine, be careful, fasten your seat belt

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

FASTENgine

High-performance C++ engine. The repository today carries its documentation and context, not engine code: the agent context in .agents/, the architecture documentation in docs/arc42/, the specifications under docs/specs/, and src/ waiting for the first modules.

Start here

This page is the entry point. From here:

  1. Development manual — the walkthrough of working in this repository: getting started, the feature process end to end, layout, toolchain, workflows, working with agents, documentation guides, and the glossary. Read it first.
  2. Conventions — the binding rules for code, tests, commits and documentation.
  3. Architecture documentation — the arc42 document of the engine (AsciiDoc; build it with doit docs).
  4. The API site — the Doxygen build, including the architecture as converted pages; publishable as a standalone site.
  5. Agent context — the optional accelerator layer for AI agents; the human-facing guide to it is Working with agents.

Working here in one minute

doit                      # the CI set: verify + build + test
doit verify               # gates: context tree + specifications
doit build && doit test   # Bazel via Bazelisk
doit docs                 # build all documentation into build/docs/

Requirements — doit, Bazel 9 (via Bazelisk), clang++ 23 or g++-16, and for the docs asciidoctor, pandoc, plantuml, doxygen. Versions and paths: Toolchain. The full command set: Workflows.

How this repository keeps order

  • Documentation in four classes, never mixed: the specifications (what is built, before it exists), the development manual (how to work here), the product documentation (the engine itself) and the agent context (agent-only artifacts that link, not copy). The split is a recorded decision: ADR-0002.
  • Features follow a process: SDD + ADR + TDD — planning packages (specification, ADRs, plan, tasks) agreed at architectural review and feature planning, implementation later and test-first; recorded in ADR-0005, extended by ADR-0006 (planning and implementation as two phases) and ADR-0007 (developer-first, agents optional); the rules: process conventions.
  • Gates run on every change: the pre-commit hook blocks on secrets and runs the tree checks (advisory); CI runs the same checks with blocking authority, plus build, test and the docs build. A change is complete only when the documentation it invalidates changes with it.
  • Decisions are recorded: anything with alternatives and lasting consequences becomes an ADR — tooling, structure, an expensive-to-change API.
  • Everything generated is a build artifact: build/** and docs/arc42/images/*.svg are produced by doit, never committed.

About

FASTENgine - Fast Engine, be careful, fasten your seat belt

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages