diff --git a/doc/README.md b/doc/README.md index 25623708a..45e98fc4f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,45 +7,55 @@ This uses Pandoc and BasicTex (LaTeX) Installed through Homebrew. ### Set Up ```bash -# See https://daniel.feldroy.com/posts/setting-up-latex-on-mac-os-x brew install pandoc brew install basictex -pandoc keystore-migration.md -o keystore-migration.pdf - # Setting up LaTex packages # First update tlmgr sudo tlmgr update --self # Then install LaTex packages -sudo tlmgr install titlesec -sudo tlmgr install framed -sudo tlmgr install threeparttable -sudo tlmgr install wrapfig -sudo tlmgr install multirow -sudo tlmgr install enumitem sudo tlmgr install bbding -sudo tlmgr install titling # Required for the fancy headers used -sudo tlmgr install tabu +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 import -sudo tlmgr install varwidth -sudo tlmgr install needspace -sudo tlmgr install tocloft # Required for \tableofcontents generation -sudo tlmgr install ntheorem -sudo tlmgr install environ +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 lastpage # Enables Page X of Y -sudo tlmgr install collection-fontsrecommended # And set up fonts -sudo tlmgr install libertine # The main font the doc uses +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.