README.md

NADO book

Build

Install Pandoc to generate an epub file. For PDF a LaTeX engine is required, see Pandoc documentation.

The following Pandoc filters are used:

• pandoc-secnos

In addition you need Graphviz.

To build the paperback version:

./make_book.sh --paperback

To build an ePub version (Latex math is rendered via Codecogs - check section 11 of the whitepaper to ensure you didn't get rate limited):

./make_book.sh --epub

To build a PDF that roughly fits a Kindle:

./make_book.sh --pdfkindle

To build a PDF that roughly fits an iPad:

./make_book.sh --pdfbig

To generate the jpeg cover images, export to PDF but set to PDF 1.6 and change Output Intended For to Screen / Web. Then do:

cd meta
convert -density 180 -define pdf:use-trimbox=true nado-cover-rgb.pdf -crop 52.25x100% +repage \( -clone 0 -crop 92x100% +repage -reverse \) -delete 0 -reverse slice.jpg
mv slice-2.jpg ../docs/front.jpg
mv slice-0.jpg ../docs/back.jpg
mv slice-1.jpg spine.jpg

Preview

Use Apple Books, Kindle Previewer, etc to view the epub.

Contribute

See STYLE.md for the markdown style used, e.g. how to add links and footnotes.

To preview documentation:

bundle exec jekyll server --incremental --source docs