From d1ba57009db7636aea549486907a8edd1c9cf456 Mon Sep 17 00:00:00 2001 From: Emil Miler Date: Sat, 1 Jun 2024 11:52:42 +0200 Subject: [PATCH] Describe Docker usage [ci skip] --- readme.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/readme.md b/readme.md index 6d21aab..7a8715c 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,26 @@ - `ghostscript` - `zola` (optional) +You can [install ChordPro][1] 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 +``` + +[1]: https://www.chordpro.org/chordpro/chordpro-installation/ + ## Building `make` defaults to `all` which builds individual PDF and HTML files for