From 96da109ac14976380650fc92ea4a0b50c918e75c Mon Sep 17 00:00:00 2001
From: William Petit <wpetit@cadoles.com>
Date: Thu, 21 Nov 2019 16:07:33 +0100
Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20du=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index ec24d47..e40afd6 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,39 @@
 
 Utilitaire de transformation de rapport de tests [JUnit](https://junit.org/) (un format courrant dans les frameworks de test) au format [Markdown](https://en.wikipedia.org/wiki/Markdown) via un template personnalisable.
 
+## Usage
+
+```
+junit2md <raport_junit1.xml> <raport_junit1.xml> <etc>
+```
+
+La version Markdown sera envoyée sur la sortie standard.
+
+## Démarrer avec les sources
+
+### Dépendances de développement
+
+- [Go >= 1.13.4](https://golang.org/)
+- [modd](https://github.com/cortesi/modd)
+- [packr2](https://github.com/gobuffalo/packr)
+
+### Procédure d'amorçage
+
+```
+git clone https://forge.cadoles.com/Cadoles/junit2md.git
+cd junit2md
+make watch
+```
+
+### Générer une release
+
+```
+make release
+```
+
+Les archives contenant les releases seront disponibles dans le répertoire `release/`.
+
+
 ## Licence
 
 [GPL-3.0](./LICENSE)
\ No newline at end of file