From aa5372c7c1434deeb5d17a1de36b5f8b2775f900 Mon Sep 17 00:00:00 2001
From: nicolas <nicolas.raymond@ensiie.fr>
Date: Fri, 4 Mar 2022 02:46:44 +0100
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..038b668
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# LConvertorL
+
+Un script simple de conversion de relevé bancaire LCL du format PDF au format CSV.
+Il fournis un fichier CSV formaté pour pouvoir être directement coller dans le fichier de compta.
+
+
+## Installation
+
+Récupération du script:
+`git clone -`
+
+Installation des dépendences:
+`pip install "camelot-py[cv]" pandas argparser`
+
+*OPTIONEL* Ajout du script dans les bin pour être utilisable partout:
+```bash
+cd LConvertorL
+ln -s $(pwd)/releve2csv $HOME/.local/bin
+```
+
+## Usage
+
+```bash
+$ releve2csv -h
+
+usage: releve2csv [-h] [-o OUT] [--full-label] path
+
+Un simple script de convertion de relevé LCL pdf vers csv
+
+positional arguments:
+  path               Chemin du relevé pdf à convertire
+
+options:
+  -h, --help         show this help message and exit
+  -o OUT, --out OUT  Chemin du fichier csv de sortie
+  --full-label       Exporte toutes les lignes du relevé (dont REF et LABEL)
+`
-- 
GitLab