Skip to content

Commit

Permalink
Merge pull request unicef#69 from unicef/pdfREADME
Browse files Browse the repository at this point in the history
  • Loading branch information
lacabra authored Jan 1, 2022
2 parents 9857cd8 + 7c22f79 commit 8191e0b
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions pdf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# PDF Generation of Toolkit

The contents of this folder are used towards the automated generation of a PDF of the Digital Public Goods Toolkit. This is accomplished through the preprocessing and subsequent collating of selected Markdown files to output a single PDF file.

## Requirements

Generating a PDF requires both `pandoc` (v2.9 or higher) and `TeX` to be installed in the system.

* MacOS: Run the following commands to install the necessary dependencies

```bash
brew install pandoc
brew install basictex
sudo tlmgr update --self
sudo tlmgr install titlesec
```

## Generate the PDF

Simply run `make` inside this folder:

```bash
cd pdf
make
```

which will output a file named `publicgoods-toolkit.pdf`.

Refer to the inline documentation in the [Makefile](Makefile) for the specific steps in preprocessing and correctly ordering the Markdown files, and [CONTRIBUTING](../CONTRIBUTING.md) for the conventions used throughout this project to maintain consistency.

0 comments on commit 8191e0b

Please sign in to comment.