Browse Source

Add toolchain overview to the readme

toolchain-overview
oliverpool 6 years ago
committed by GitHub
parent
commit
003085d035
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 11
      README.rst

11
README.rst

@ -71,6 +71,17 @@ Documentation
The full documentation is hosted by readthedoc, here : http://patacrep.readthedocs.org/ (currently only in french).
Toolchain overview
------------------
The following steps happen by default (see [build.py](https://github.com/patacrep/patacrep/blob/master/patacrep/build.py#L19):
1. `tex` generate a LaTeX file, based on the list of files mentionned in the songbook (a conversion to LaTeX formats happens for ChordPro files)
2. `pdf` generates a pdf, using `lualatex`
3. `sbx` make .sbx indexes from .sxd files
4. `pdf` generate a pdf again, with the index
5. `clean` removes the temporary files
Contact & Forums
----------------

Loading…
Cancel
Save