crowd-funder-for-time-pwa/doc/README.md

# TimeSafari Docs

## Generating PDF from Markdown on OSx

This uses Pandoc and BasicTex (LaTeX) Installed through Homebrew.

### Set Up

```bash 
brew install pandoc

brew install basictex

# Setting up LaTex packages

# First update tlmgr
sudo tlmgr update --self

# Then install LaTex packages
sudo tlmgr install bbding
sudo tlmgr install enumitem
sudo tlmgr install environ
sudo tlmgr install fancyhdr
sudo tlmgr install framed
sudo tlmgr install import
sudo tlmgr install lastpage  # Enables Page X of Y
sudo tlmgr install mdframed
sudo tlmgr install multirow
sudo tlmgr install needspace
sudo tlmgr install ntheorem
sudo tlmgr install tabu
sudo tlmgr install tcolorbox
sudo tlmgr install textpos
sudo tlmgr install titlesec
sudo tlmgr install titling  # Required for the fancy headers used
sudo tlmgr install threeparttable
sudo tlmgr install trimspaces
sudo tlmgr install tocloft  # Required for \tableofcontents generation
sudo tlmgr install varwidth
sudo tlmgr install wrapfig

# Install fonts
sudo tlmgr install cmbright
sudo tlmgr install collection-fontsrecommended # And set up fonts
sudo tlmgr install fira
sudo tlmgr install fontaxes
sudo tlmgr install libertine # The main font the doc uses
sudo tlmgr install opensans
sudo tlmgr install sourceserifpro

```

#### References

The following guide was adapted to this project except that we install with Brew and have a few more packages.

Guide: https://daniel.feldroy.com/posts/setting-up-latex-on-mac-os-x

### Usage

Use the `pandoc` command to generate a PDF.

```bash
pandoc usage-guide.md -o usage-guide.pdf 
```

And you can open the PDF with the `open` command.

```bash
open usage-guide.pdf
```

Or use this one-liner
```bash
pandoc usage-guide.md -o usage-guide.pdf && open usage-guide.pdf
```