docs.rs failed to build cantara-songlib-0.2.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Cantara-Songlib
A reimplementation of the Cantara Backend in Rust.
This crate provides functionality for parsing songs in different formats (lyrics, scores and different languages) and export them as a song presentation or music sheet. It is part of the effort to rewrite Cantara in Rust.
[!NOTE] While this crate is already usable, some functions are yet to be implemented. Please expect breaking changes.
Documentation
| Document | Contents |
|---|---|
| docs/data-model.md | The Song model: parts, orders, voices, multiple languages, metadata |
| docs/lilypond-export.md | Sheet music export and rendering |
| docs/abc-export.md | ABC notation export |
| docs/ccli-import.md | Reading CCLI SongSelect exports in any language |
| docs/meta-information.md | The meta information line on slides: template and placement |
| docs/complex-slides.md | Slides stacking notation and several languages |
| docs/text-export.md | Plain text, Markdown/Telegram markup, and exporting several songs |
Repository layout
src/
├── song.rs the data model every importer and exporter shares
├── importer/ .song (classic), .song.yml, .ccli, .cssf readers
├── exporter/ slides, LilyPond, ABC, text writers
├── slides.rs presentation slide types
├── templating.rs the meta information template
├── lib.rs library entry point and C FFI
└── main.rs the command line wrapper
tests/
├── data/ song files used by the tests and examples
└── *.rs integration tests
examples/ runnable demonstrations (cargo run --example …)
docs/ prose documentation
Command line