From b86503efa63d8108dc0e0870f7f944e2893b9ddd Mon Sep 17 00:00:00 2001 From: Yann Esposito Date: Wed, 30 Mar 2016 14:44:01 +0200 Subject: [PATCH] added more information in README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8bda527..530df2b 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,25 @@ theme: metropolis --- # No Brainer Markdown to HTML & PDF -Given a tree of markdown file, generate an HTML and PDF generated file for each. -Just launch. +For each markdown files it will generate: + +- an HTML Document +- an HTML Presentation (using reveal.js) +- a PDF Document (using XeLaTeX) +- a PDF Presentation (using Beamer) ~~~ ./compile.sh ~~~ +If you want to be the 1337, install [`stack`](http://haskellstack.org) +and + +~~~ +./build.sh +./compile +~~~ + ## Dependencies - [pandoc](http://pandoc.org) -- Tested with pandoc 1.15.0.6