From 1bd13665ed7cb58318e6a5d9e5003199411c979f Mon Sep 17 00:00:00 2001 From: Dmytro Bogatov <dmytro@dbogatov.org> Date: Thu, 7 Dec 2017 22:30:45 -0500 Subject: [PATCH] Add build instructions. --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1dbca38..91ba90a 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,29 @@ This presentation is developed by Dmytro Bogatov (dmytro@bu.edu) BU CS PhD stude Presentation is written in LaTeX using beamer package. It is compile in CI system (Gitlab CI) which checks spelling, lints latex code, verifies `bibfile.bib` and complies source to PDF file (see [.gitlab-ci.yml](.gitlab-ci.yml)). -Main repo is [https://git.dbogatov.org/bu/PathORAM-Talk](https://git.dbogatov.org/bu/PathORAM-Talk). +Main repo is [git.dbogatov.org/bu/PathORAM-Talk](https://git.dbogatov.org/bu/PathORAM-Talk). + +## How to compile + +Prerequisites +* Modern TeX distribution (2016 and later) + * biber + * xelatex +* Fira Sans font (https://github.com/carrois/Fira) +* bash 4 (and later) + +Or, use `dbogatov/docker-images:latex-latest` docker image. + + # just presentation + ./build.sh + + # presentation with notes + ./build.sh -n on -j presentation-with-notes + + # just bibliography + ./build.sh -b + +Output files are in `./dist/`. ### Legal -- GitLab