Files
CoCoCapitalQuiz/docs/manual/README.md
T

28 lines
1.5 KiB
Markdown

# Capital Quest player manual source
CAPITALQUEST.md is the authoritative plain GFM player manual. manual.json holds
cover/website metadata. images/ contains selected unmodified guest frames;
screenshots.json records exact hashes, machine/app configuration and disk identity.
The manual is © Brian K. Holman 2026, GPL-3.0-or-later. Map artwork and the other
components keep their own notices; see assets/CREDITS.md and docs/PROVENANCE.md.
Generate the PDF with the shared VCC Plus documentation exporter, not a separate
game-specific renderer. From the VCCPlus checkout, supply these selected files:
```sh
python3 tools/documentation/export_pdf.py prepare /path/to/CapitalQuest/docs/manual/CAPITALQUEST.md \
--metadata /path/to/CapitalQuest/docs/manual/manual.json --toc \
--destination /path/to/ignored-output/Capital-Quest-Manual.pdf
```
Inspect every rendered page and its links/captions, then run the exporter's
publish REVIEW_DIRECTORY --reviewed action. Changes to source, metadata, images
or shared templates invalidate the review. Generated PDFs/review outputs remain
outside tracked sources.
The website owner imports an explicit snapshot with scripts/import-project-manual.py,
slug capital-quest, this Markdown/metadata and the exact reviewed PDF. Its shared
layout owns desktop/mobile presentation and prominent disk/source/PDF actions.
The online route is https://vccplus.brianholman.com/games/capital-quest/ . Import
and PDF generation do not publish software or change the emulator.