forked from unicef/publicgoods-toolkit
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request unicef#69 from unicef/pdfREADME
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |