Describe Docker usage
[ci skip]
This commit is contained in:
parent
5938e9a346
commit
d1ba57009d
20
readme.md
20
readme.md
@ -4,6 +4,26 @@
|
|||||||
- `ghostscript`
|
- `ghostscript`
|
||||||
- `zola` (optional)
|
- `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
|
## Building
|
||||||
|
|
||||||
`make` defaults to `all` which builds individual PDF and HTML files for
|
`make` defaults to `all` which builds individual PDF and HTML files for
|
||||||
|
Loading…
Reference in New Issue
Block a user