From 34f83e52f9a74d22f236b0241a04d9d02ac4b471 Mon Sep 17 00:00:00 2001
From: coolneng <akasroua@gmail.com>
Date: Sun, 17 Nov 2019 16:25:08 +0100
Subject: [PATCH] Add Readme

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..09208ca
--- /dev/null
+++ 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.