Add Readme

2019-11-17 16:34:56 +01:00
1 changed files with 30 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,30 @@
+Curriculum vitae
+================
+
+Curriculum vitae template that uses LaTeX for rendering, via Pandoc. If
+you want to adapt it to your needs:
+
+  ---------------------| ---------
+  Sections and layout  | Details
+  *.latex              | *.yml
+  ---------------------| ---------
+
+Requirements
+------------
+
+-   Pandoc
+-   GNU Make
+-   LaTeX (only tested with TeX Live)
+
+Usage
+-----
+
+Compile the documents using make
+
+```shell
+make
+```
+
+shell
+
+The pdf documents will appear in the same folder.