added more information in README

This commit is contained in:
Yann Esposito 2016-03-30 14:44:01 +02:00
parent fb972dc072
commit b86503efa6

View file

@ -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