From 87352936b0b6ec8aa93e8541cd824491ee035888 Mon Sep 17 00:00:00 2001 From: Emil Miler Date: Sat, 1 Jun 2024 11:35:00 +0200 Subject: [PATCH] Describe Docker installation [ci skip] --- readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/readme.md b/readme.md index 6d21aab..15114b5 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,16 @@ - `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" +``` + +[1]: https://www.chordpro.org/chordpro/chordpro-installation/ + ## Building `make` defaults to `all` which builds individual PDF and HTML files for