Add Readme

2019-11-17 16:25:08 +01:00 · 2019-11-17 16:25:08 +01:00 · f83ab628bb
parent 4c858c5052
commit f83ab628bb
1 changed files with 22 additions and 0 deletions
--- a/README.org
+++ b/README.org
@ -0,0 +1,22 @@
+* Curriculum vitae
+
+Curriculum vitae template that uses LaTeX for rendering, via Pandoc. If
+you want to adapt it to your needs:
+
+- Sections and layout: .latex
+- Details: .yml
+
+** Requirements
+   - Pandoc
+   - GNU Make
+   - LaTeX (only tested with TeX Live)
+
+** Usage
+
+  Compile the documents using make
+
+#+BEGIN_SRC sh
+  make
+#+END_SRC
+
+  The pdf documents will appear in the same folder.