From 26ada96c25a2524f02cfd50d44f09ae19c083ef1 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 | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/readme.md b/readme.md index 6d21aab..41fcd8a 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,14 @@ - `ghostscript` - `zola` (optional) +The makefile uses Docker with the official iamge `chordpro/chordpro:latest`. +It can be seamlesly integrated with a shell alias in case you want to use +chordpro directly in your shell outside of make: + +``` +alias chordpro="docker run -ti --rm --env HOME=\$HOME --env USER=\$USER --workdir \$(pwd) --volume \$HOME:\$HOME chordpro/chordpro:latest chordpro" +``` + ## Building `make` defaults to `all` which builds individual PDF and HTML files for