beffroi-tools/docs/README.md

3.7 KiB
Raw Permalink Blame History

Documentation

Project portal · Changelogs · Development

Read the full manuals → — searchable mdBook documentation for this repository’s five tools and the independently maintained Canvas Pilot.

Tools

Tool Start here Reference and background
PPTX Reporter Guide · Visual walkthrough Report formats · Windows quick start · Portable quick start
Rundown Converter Guide · Portable quick start Corpus findings · Plan
Canvas Pilot Introduction · User guide Resolutions and cropping · Device checks · Plan
PDF Presenter Repository (access required; foundation only) Implementation plan · CI
ASCII Names Guide Changelog
Document Exporter Guide Changelog
MPC-HC Companion Setup and development Changelog

Shared resources

Where documentation belongs

Keep each tool's guide, plans, screenshots and changelog in its named folder. Shared contributor instructions live in development/, historical release notes in releases/, and cross-tool research in planning/. The Companion setup guide stays beside its module source.

Keep save/export contracts and their versioned examples in interfaces/, and reusable starter documents in templates/. These files are also used by tests; update incoming links and code or packaging references whenever a document moves.