Skip to content

README.md

Latest commit

 

History

History
32 lines (25 loc) · 1.29 KB

README.md

File metadata and controls

32 lines (25 loc) · 1.29 KB
Raw

ActiveBlockference manuscript

This directory is the publication source for ActiveBlockference. It follows the ordered manuscript convention used by the Institute template code project:

  • 00_...md through 09_...md contain the narrative in compilation order.
  • 99_references.md is deliberately last so the references heading remains contiguous with the bibliography in rendered formats.
  • config.yaml records paper metadata and the reproducible experiment used by the figures.
  • references.bib is the complete citation database.
  • preamble.md documents renderer expectations and the PDF command.
  • figures/ contains the publication figures generated by scripts/build_manuscript.py.

Build and validate

From the repository root:

uv run python scripts/validate_manuscript.py
uv run python scripts/build_manuscript.py
uv run python scripts/build_manuscript.py --check

The builder numbers equations, definitions, propositions, algorithms, figures, tables, and sections from their source order. Cross-references use the labels in SYNTAX.md, and citations use keys from references.bib.

The composed Markdown and optional PDF live under docs/_build/, which is reproducible and excluded from version control. Change the ordered source, then rerun the builder and validation commands.