1.6 KiB
Requirements
chordproghostscriptzola(optional)
You can install ChordPro directly on your machine, or use Docker
with the official iamge chordpro/chordpro:latest. It can be seamlesly
integrated with a shell alias:
alias chordpro="docker run -ti --rm --env HOME=\$HOME --env USER=\$USER --workdir \$(pwd) --volume \$HOME:\$HOME chordpro/chordpro:latest chordpro"
This will not function with the included makefile, so you will have to
export this as a shell function (for example in .bashrc):
chordpro() {
docker run -ti --rm --env HOME=$HOME --env USER=$USER --workdir "$(pwd)" --volume "$HOME:$HOME" chordpro/chordpro:latest chordpro "$@"
}
export -f chordpro
Building
make defaults to all which builds individual PDF and HTML files for
all songs. It also builds one complete PDF songbook with all songs.
Available targets: all, pdf, html, clean
You can also build PDF for a specific page with:
chordpro --config=chordpro.json path/to/song.cho
or build HTML output with:
chordpro --config=chordpro.json -o path/to/song.html path/to/song.cho
Static website output
Futhermore, the project is ready to be compiled into a static webpage using Zola.
zola build
This is done by default during the deploy pipeline.
Song management
The manage shell script lets you do basic song management and saves you some
manual labour. Simply run the script itself or invoke help to get a list of
all available commands.