From bab6fc98f8cf4666ee339cae312a1713cb548f12 Mon Sep 17 00:00:00 2001 From: Henry Addison Date: Mon, 17 Sep 2018 12:41:03 +0100 Subject: [PATCH] update README to use Make commands and to include details on PDF and printable versions --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c3c56d..45a1b40 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,26 @@ These are the slides for a short presentation introducing retrospectives that I * [cleaver](https://github.com/jdan/cleaver) ## Usage + +Releases will include built versions of the slides. + +The instructions to build your own follow. + +### Slides for browser user +```bash +make slides.html +open slides.html +``` + +### Printer friendly version of slides +```bash +make printable-slides.html +open printable-slides.html +``` +The releases also contain a PDF version of these printer-friendly slides. + +### Speaker notes as PDF ```bash -cleaver slides.md +make speaker-notes.pdf +open speaker-notes.pdf ```