Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"usage-examples" style documentation #23

Open
uliska opened this issue Jun 10, 2017 · 0 comments
Open

"usage-examples" style documentation #23

uliska opened this issue Jun 10, 2017 · 0 comments

Comments

@uliska
Copy link
Contributor

uliska commented Jun 10, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant