From 003085d0353f45fc2c1d31949a71fb5ba1a67768 Mon Sep 17 00:00:00 2001 From: oliverpool Date: Fri, 16 Nov 2018 09:49:52 +0100 Subject: [PATCH] Add toolchain overview to the readme --- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.rst b/README.rst index ada77713..d8d1f8c3 100644 --- a/README.rst +++ b/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 ----------------