From: Niki Roo <niki@nikiroo.be>
Date: Thu, 19 Sep 2019 06:37:55 +0000 (+0200)
Subject: README
X-Git-Url: https://git.nikiroo.be/?a=commitdiff_plain;h=966d62609ff6b19a20f8aa60506cd477c51fe5aa;p=fanfix-jexer.git

README
---

diff --git a/README-fr.md b/README-fr.md
index 5a0d7f8..777840a 100644
--- a/README-fr.md
+++ b/README-fr.md
@@ -120,6 +120,20 @@ Quelques tests unitaires sont disponibles :
 
 ```./configure.sh && make build test run-test```
 
+Si vous faites tourner les tests unitaires, sachez que certains fichiers flags peuvent les impacter:
+
+- ```test/VERBOSE```      : active le mode verbeux pour les erreurs
+- ```test/OFFLINE```      : ne permet pas au programme de télécharger des données
+- ```test/URLS```         : permet au programme de tester des URLs
+- ```test/FORCE_REFRESH```: force le nettoyage du cache
+
+Notez que le répertoire ```test/CACHE``` peut rester en place; il contient tous les fichiers téléchargés au moins une fois depuis le réseau par les tests unitaires (si vous autorisez les tests d'URLs, lancez les tests au moins une fois pour peupler le CACHE, puis activez le mode OFFLINE, ça marchera toujours).
+
+Les fichiers de test seront:
+
+- ```test/*.url```  : des URLs à télécharger en fichier texte (le contenu du fichier est l'URL)
+- ```test/*.story```: des histoires en mode texte (le contenu du fichier est l'histoire)
+
 ### Librairies dépendantes (incluses)
 
 Nécessaires :
diff --git a/README.md b/README.md
index 7e7c3b9..43a0f40 100644
--- a/README.md
+++ b/README.md
@@ -120,6 +120,21 @@ There are some unit tests you can run, too:
 
 ```./configure.sh && make build test run-test```
 
+If you run the unit tests, note that some flag files can impact them:
+
+- ```test/VERBOSE```      : enable verbose mode
+- ```test/OFFLINE```      : to forbid any downloading
+- ```test/URLS```         : to allow testing URLs
+- ```test/FORCE_REFRESH```: to force a clear of the cache
+
+Note that ```test/CACHE``` can be kept, as it will contain all internet related files you need (if you allow URLs, run the test once which will populate the CACHE then go OFFLINE, it will still work).
+
+The test files will be:
+
+- ```test/*.url```  : URL to download in text format, content = URL
+- ```test/*.story```: text mode story, content = story
+
+
 ### Dependant libraries (included)
 
 Required: