Skip to content

Commit

Permalink
Changed Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dendibakh authored Dec 8, 2023
1 parent b3e9707 commit 5ce25de
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,20 @@ For examples on how to add images, table, code listings, etc, see [how-to.md](ho

# Building a book (pdf)

At the moment, building a PDF only works on Windows and Linux. MacOS requires building some components (e.g. pandoc-crossref from sources).

Requirements:

* Python3. Install natsort module: `pip install natsort`.
* [pandoc](https://pandoc.org/installing.html) - install [version 2.9](https://github.com/jgm/pandoc/releases/tag/2.9.2.1).
* install pandoc filters: `pip install pandoc-fignos pandoc-tablenos`
* install `pandoc-crossref`. This one requires manual installation. I just downloaded the binary from [here](https://github.com/lierdakil/pandoc-crossref/releases/tag/v0.3.6.4) and copied it to the same place where `pandoc-fignos` is.
* [MiKTeX](https://miktex.org/download) - check `Yes` for automatic packets installation
* [MiKTeX](https://miktex.org/download) - check `Yes` for automatic package installation

Run:
```bash
# Linux bash & Mac
python.exe export_book.py && pdflatex book.tex && bibtex book && pdflatex book.tex && pdflatex book.tex
# Linux bash
python export_book.py && pdflatex book.tex && bibtex book && pdflatex book.tex && pdflatex book.tex

# Windows Powershell
function Run-Block-With-Error($block) {
Expand Down

0 comments on commit 5ce25de

Please sign in to comment.