From 29e8ac75d1fcba20148281b81e2a0f2a9763ceff Mon Sep 17 00:00:00 2001
From: Antoine Ouvrard <antoine.ouvrard@nereide.fr>
Date: Mon, 28 Jun 2021 18:51:11 +0200
Subject: [PATCH] =?UTF-8?q?Compl=C3=A8te=20le=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8216d68..01223d8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
 # cv-aou
 
-CV de Antoine en markdown de base puis généré en pdf et html depuis le markdown
\ No newline at end of file
+Transforme un texte markdown en:
+  - html (avec css spécifique)  
+  - pdf (avec latex)
+
+Fonctionnement:
+  - Saisir son texte au format markdown dans le dossier `input-cv-md`
+  - Executez le script bash `build.sh` pour générer le pdf et/ou le html
+
+```
+build.sh -h                                                            18:25:40
+
+Script qui transforme des fichiers markdown en pdf et html avec le même style.
+
+ -k       conserve les fichiers de construction
+--pdf     génère seulement le pdf
+--html    génère seulement le html
+
+aucun paramètre génèrera les deux formats
+```
+
+inspiré de http://mszep.github.io/pandoc_resume/