From da3b618defbd013fa80de73948ac055be8cfa930 Mon Sep 17 00:00:00 2001
From: Yorick Barbanneau <ephase@xieme-art.org>
Date: Sun, 18 Nov 2018 00:25:22 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..391a28d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+Script de validation des Challenge 42 et 43
+-------------------------------------------
+
+Ce script permet de vérifier les codes de sorties retournées par les script des
+challenges 42 et 43 du MOOC bash de la licence ADSILLH promotion 2018-2019.
+
+## Installation
+
+Pour installer le script, il suffit de cloner ce dépôt et d'initialiser le
+sous module message (disponible aussi dans mes dépôts git)
+
+```shell
+git clone https://git.epha.se/ephase/moocbash_test
+cd moocbash_test
+git submodule init && git submodule update
+```
+
+## Exécution
+
+Pour contrôler la sortie de `ouinon.sh` du challenge 43, il suffit de faire:
+
+```shell
+./test.sh -d ~/alice/Sequence4/A43 -s ouinon.sh -t q431.txt
+```
+
+### Paramètres
+
+ - `-d` répertoire contenant le script à tester (et les fichiers nécessaires),
+     sans notre cas `~/alice/Sequence4/A42` et `~/alice/Sequence4/A43`
+ - `-s` fichier script à tester
+ - `-t` fichier de test, il sont tous contenu dans le répertoire de notre
+     script. Chaque fichier contient un test pas ligne sous la forme
+     `<arguments>:<code_retour>`
+
+### Sortie
+
+Le script fournira alors la sortie suivante :
+
+```shell
+ADSILLH Bash return code test
+Test ouinon.sh script with /net/cremi/ybarbanneau/moocbash_test/q431.txt
+
+
+Script *ouinon.sh*, paramètres
+    Le code de retour est celui attendu (3)
+    Retour : Vous n'avez pas donné votre réponse.
+
+Script *ouinon.sh*, paramètres o o
+    Le code de retour est celui attendu (4)
+    Retour : Donnez une seule réponse.
+
+Script *ouinon.sh*, paramètres O
+    Le code de retour est celui attendu (0)
+    Retour : oui
+[...]
+```
+
+Le script donne pour chaque test le script lancé et les arguments passés, il
+indique ensuite si le code de retour du script avec les arguments donnés est
+celui attendu en l'indiquant entre parenthèses. La sortie du script est affiché
+(`stdout` et `stderr`)
+
+En cas de retour différent de celui attendu pour un test, le script affichera
+
+```
+Le code de retour n'est pas correct script : 6 attendu : 34
+```