This commit is contained in:
		
							
								
								
									
										21
									
								
								readme.md
									
									
									
									
									
								
							
							
						
						
									
										21
									
								
								readme.md
									
									
									
									
									
								
							@@ -1,12 +1,14 @@
 | 
			
		||||
My personal guitar chord-book written in [ChordPro](https://www.chordpro.org/).
 | 
			
		||||
 | 
			
		||||
## Requirements
 | 
			
		||||
 | 
			
		||||
- [`chordpro`](https://github.com/ChordPro/chordpro/)
 | 
			
		||||
- `ghostscript`
 | 
			
		||||
- `zola` (optional)
 | 
			
		||||
- `docker`
 | 
			
		||||
- `ghostscript` (optional for `songbook` make target)
 | 
			
		||||
- `zola` (optional for web deployment)
 | 
			
		||||
 | 
			
		||||
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:
 | 
			
		||||
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"
 | 
			
		||||
@@ -14,10 +16,15 @@ alias chordpro="docker run -ti --rm --env HOME=\$HOME --env USER=\$USER --workdi
 | 
			
		||||
 | 
			
		||||
## 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.
 | 
			
		||||
`make` defaults to `pdf` which builds individual PDF files for all songs.
 | 
			
		||||
 | 
			
		||||
Available targets: `all`, `pdf`, `html`, `clean`
 | 
			
		||||
Target | Description
 | 
			
		||||
-|-
 | 
			
		||||
`all` | `pdf`, `html`, `songbook`
 | 
			
		||||
`pdf` | Build individual PDF files
 | 
			
		||||
`html` | Build individual HTML files
 | 
			
		||||
`songbook` | Build one complete PDF songbook with all songs
 | 
			
		||||
`clean` | Remove all generated files
 | 
			
		||||
 | 
			
		||||
You can also build PDF for a specific page with:
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user