diff --git a/README.md b/README.md index 8d8d485..0cec5d3 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,23 @@ This repos aims to show a structured way to generate an html/pdf slideshow from markdown files it depends on `pandoc` for compiling to pdf/html and `inotify-tools` for watching changes. + +## Usage + +### Slides in HTML/RevealJS: + +- `make html`: for creating the html file +- `make serve_html`: for launching the server, then open [https://localhost:7777](https://localhost:7777) on your browser + + + +### Slides in PDF/LateX: + +- `make pdf`: for creating the pdf file + +Then open the pdf file in your favorite pdf reader + + +### Compiling the slideset when modifications occur + +- `make watch` should launch an inotiy loop recompiling a pdf by default (for html, launch: `make watch html`)