README.md

Scores

Library of LilyPond music score files, with a development environment for editing scores and generating output files.

Installation

Nix

The recommended way to install the build and development dependencies is with Nix. On non-NixOS systems, use the Determinate Systems Nix Installer.

Once Nix is installed, use nix develop to download the dependencies and activate the development shell, or, preferably, install direnv (for example, using these dotfiles) to automatically activate the environment when cd-ing into the project directory. Assuming you installed direnv, as well as just, and nushell (which will be installed when running nix develop), a automatic development environment can be created by running:

just init

Manual

If not using Nix, install the following dependencies via your preferred method. More information about each dependency can be found by clicking the "Homepage" link on each page listed below.

• fd-10.1.0
• gh-2.51.0
• gyre-fonts-2.005
• just-1.29.1
• lilypond-2.25.16
• lychee-0.15.1
• nushell-0.94.1
• pre-commit-3.7.1
• python3.12-pre-commit-hooks-4.6.0
• ripgrep-14.1.0
• tokei-12.1.2
• watchexec-2.1.1
• zathura-with-plugins-0.5.6
• zellij-0.40.1

Recommended extra dependencies

For PDF viewing (macOS only):

• Skim

Development

Development commands are provided through just. Run just to see available "recipes," and just <recipe> --help/-h to get more information about a particular recipe.

Available recipes:
(run `just <recipe> --help/-h` for more info)
    check *hooks             # Run pre-commit hooks
    clean *search_term       # Remove pdfs
    compile *search_term     # Compile pdfs
    create *args             # Create new score
    deps *args               # List dependencies
    edit *args               # Open <score> in  and pdf viewer, recompiling on file changes
    find-recipe *search_term # Search available `just` recipes
    history *search_term     # Search project history
    info *search_term        # Get info about scores
    init *help               # Initialize direnv environment
    issue *args              # View issues
    open *search_term        # Open pdfs
    remote *web              # View remote repository
    settings *args           # View project settings
    stats *help              # View repository analytics
    templates *args          # View available templates
    update *help             # Update dependencies and score LilyPond version
    view-source *recipe      # View the source code for a recipe