beffroi-tools/docs
Dandaedre 02ca8af9e2
Beffroi/beffroi-tools/pipeline/head This commit looks good Details
Add timed automatic refresh for Midra input previews
2026-11-14 18:05:59 +01:00
..
ascii-names Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
development Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
exporter Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
interfaces Add timed automatic refresh for Midra input previews 2026-11-14 18:05:59 +01:00
media-player-classic Add generated app icons and cross-platform desktop launchers 2026-11-14 14:14:59 +01:00
midra-layout Add timed automatic refresh for Midra input previews 2026-11-14 18:05:59 +01:00
planning Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
pptx-reporter Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
releases Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
rundown-converter Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
templates/midra-layout Add PPTX Figma and Illustrator layout templates 2026-11-14 16:48:47 +01:00
README.md Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00
changelogs.md Organize documentation by tool and update references 2026-11-14 17:57:06 +01:00

README.md

Documentation

Project portal · Changelogs · Development

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
Midra Layout Guide Resolutions and cropping · Device checks · Plan
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.