doc: adding README to explain how to generate the pdf using pandoc

3e0f5411 · Benoit Rat · 789c4a66 · 3e0f5411
Commit 3e0f5411 authored Oct 07, 2019 by Benoit Rat
Hide whitespace changes
Inline Side-by-side

Showing with 37 additions and 0 deletions

README.md doc/README.md +37 -0

No files found.
--- a/doc/README.md
+++ b/doc/README.md
+Intro
+==========
+
+
+The document has been written in markdown format and can be directly
+read from github, gitlab or bitbucket
+
+
+
+PDF Generation
+===============
+
+You might need to install `pandoc` software to generate `.pdf` from `.md`.
+
+	sudo apt-get install pandoc
+
+To generate a specific document you should enter its own directory and execute
+
+	make
+
+If you have some Latex compilation error please install the following packages
+
+	sudo apt-get install texlive texlive-latex-extra
+
+### pandoc.latex
+
+The file pandoc.latex is a latex template in order to add all special latex customization
+to the markdown file. In case some of latex package are not working properly, the user
+should try to modify this file.
+
+
+Syntax
+===========
+
+> ***NOTES:*** The syntax used in this document is Markdown. We recommand to follow the strict
+markdown syntax explained on [bitbucket](https://bitbucket.org/tutorials/markdowndemo). 
+