Reference Documentation

This section contains technical reference documentation for mkmapdiary's internal formats, configurations, and development information.

Command Line Interface

• Commands - Complete command reference and examples for the build, config, generate-demo, calibrate and inspect subcommands

Configuration

• Configuration - Complete configuration reference and examples

File Formats

• Supported Source Formats - Input file formats that mkmapdiary can process
• Calibration files - The calibration.yaml that describes a source subtree's clock, effects and creator

Development

• Task Dependencies - Flowchart showing how build tasks depend on each other
• Development Commands - Commands for development and testing
• Commit Prefixes - Git commit message conventions
• System Dependencies - External binaries mkmapdiary invokes as subprocesses
• Credits - License and the open source packages mkmapdiary builds on