openlilylib / oll-core

Library Infrastructure for LilyPond add-ons
17 stars 13 forks source link

"usage-examples" style documentation #23

Open uliska opened 7 years ago

uliska commented 7 years ago

Currently we have usage-examples subdirectories that contain self-contained LilyPond files demonstrating the capabilities of the package. Depending on the author these are surrounded by more or less comprehensive textual documentation.

My suggestion is to restrict these usage-examples to mere score examples with some metadata only in a \header block. If compiled standalone this can print basic titles, but usually the file will be referenced by a Markdown file and the resulting score excerpt integrated in the output.

The usage-examples files can also be used to create a system of regression tests.

Blocks #26