Merge commit '77d3a60869e7a780c6ae069e51530e1eacece5e2'

[fanfix.git] / README-fr.md

diff --git a/README-fr.md b/README-fr.md
index 041c3672a71b4ab220fc22c8ee82447f4fc43c51..777840a5beeb0ee1c9ae524f9cefb0bced2f4b3e 100644 (file)
--- a/README-fr.md
+++ b/README-fr.md
@@ -10,8 +10,12 @@ Fanfix est un petit programme Java qui peut télécharger des histoires sur inte
 - ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info)
 - ```fanfix``` --read [*id*] ([*chapter number*])
 - ```fanfix``` --read-url [*URL*] ([*chapter number*])
+- ```fanfix``` --search
+- ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*])
+- ```fanfix``` --search-tag
+- ```fanfix``` --search-tag [*index 1*]... (page [*page*]) (item [*item*])
 - ```fanfix``` --list
-- ```fanfix``` --set-reader [*reader type*]
+- ```fanfix``` --set-reader [*GUI* | *TUI* | *CLI*]
 - ```fanfix``` --server [*key*] [*port*]
 - ```fanfix``` --stop-server [*key*] [*port*]
 - ```fanfix``` --remote [*key*] [*host*] [*port*]
@@ -23,9 +27,9 @@ Fanfix est un petit programme Java qui peut télécharger des histoires sur inte
 
 (Il y a aussi une [TODO list](TODO.md) sur le site parlant du futur du programme.)
 
-TODO: screenshots TUI + Android (+ FR quand traduit)
+![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
 
-![Main GUI](screenshots/fanfix-1.3.2.png;raw=true "Main GUI")
+Une gallerie de screenshots est disponible [ici](screenshots/README-fr.md).
 
 Le fonctionnement du programme est assez simple : il converti une URL venant d'un site supporté en un fichier .epub pour les histoires ou .cbz pour les comics (d'autres options d'enregistrement sont disponibles, comme du texte simple, du HTML...)
 
@@ -34,7 +38,7 @@ Pour vous aider à organiser vos histoires, il peut aussi servir de bibliothèqu
 - d'importer une histoire depuis son URL (ou depuis un fichier)
 - d'exporter une histoire dans un des formats supportés vers un fichier
 - d'afficher une histoire en mode texte
-- d'afficher une histoire en mode GUI **en appelant un programme natif pour lire le fichier** (mais Fanfix peut convertir le fichier en HTML avant, pour que n'importe quel navigateur web puisse l'afficher)
+- d'afficher une histoire en mode GUI **nativement** ou **en appelant un programme natif pour lire le fichier** (potentiellement converti en HTML avant, pour que n'importe quel navigateur web puisse l'afficher)
 
 ### Sites supportés
 
@@ -46,7 +50,7 @@ Pour le moment, les sites suivants sont supportés :
 - https://e621.net/ : un site Furry proposant des comics, y compris de MLP
 - https://sofurry.com/ : même chose, mais orienté sur les histoires plutôt que les images
 - https://e-hentai.org/ : support ajouté sur demande : n'hésitez pas à demander un site !
-- https://www.manga-lel.com/ : un site proposant beaucoup de mangas, en français
+- http://mangas-lecture-en-ligne.fr/ : un site proposant beaucoup de mangas, en français
 
 ### Types de fichiers supportés
 
@@ -85,6 +89,10 @@ Les arguments suivants sont aussi supportés :
 - ```--convert [URL] [output_type] [target] (+info)```: convertir l'histoire vers le fichier donné, et forcer l'ajout d'un fichier .info si +info est utilisé
 - ```--read [id] ([chapter number])```: afficher l'histoire "id"
 - ```--read-url [URL] ([chapter number])```: convertir l'histoire et la lire à la volée, sans la sauver
+- ```--search```: liste les sites supportés (```where```)
+- ```--search [where] [keywords] (page [page]) (item [item])```: lance une recherche et affiche les résultats de la page ```page``` (page 1 par défaut), et de l'item ```item``` spécifique si demandé
+- ```--tag [where]```: liste tous les tags supportés par ce site web
+- ```--tag [index 1]... (page [page]) (item [item])```: affine la recherche, tag par tag, et affiche si besoin les sous-tags, les histoires ou les infos précises de l'histoire demandée
 - ```--list```: lister les histoires presentes dans la librairie et leurs IDs
 - ```--set-reader [reader type]```: changer le type de lecteur pour la commande en cours sur CLI, TUI ou GUI
 - ```--server [key] [port]```: démarrer un serveur d'histoires sur ce port
@@ -112,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 :