README for submodules
[fanfix.git] / README-fr.md
index 93708bb586a11004e205fcd10870449854f10c29..c69bd4f22e7b2ff57b96529ded27272e83e6647e 100644 (file)
@@ -4,6 +4,12 @@
 
 Fanfix est un petit programme Java qui peut télécharger des histoires sur internet et les afficher hors ligne.
 
+## 🔴 Ceci est le programme serveur et command-line
+
+Vous pouvez aussi utiliser :
+- le client graphique [Fanfix-swing](https://github.com/nikiroo/fanfix-swing/)
+- le client en mode TUI [Fanfix-jexer](https://github.com/nikiroo/fanfix-jexer/)
+
 ## Synopsis
 
 - ```fanfix``` --import [*URL*]
@@ -25,12 +31,6 @@ Fanfix est un petit programme Java qui peut télécharger des histoires sur inte
 
 (Si vous voulez juste voir les derniers changements, vous pouvez regarder le [Changelog](changelog-fr.md) -- remarquez que le programme affiche le changelog si une version plus récente est détectée depuis la version 1.4.0.)
 
-(Il y a aussi une [TODO list](TODO.md) sur le site parlant du futur du programme.)
-
-![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...)
 
 Pour vous aider à organiser vos histoires, il peut aussi servir de bibliothèque locale vous permettant :
@@ -77,12 +77,12 @@ Si vous avez des difficultés pour le compiler avec une version supportée de Ja
 
 ## Options
 
-Vous pouvez démarrer le programme en mode graphique (comme dans le screenshot en haut) :
+Vous pouvez démarrer le programme de deux façons :
 
 - ```java -jar fanfix.jar```
 - ```fanfix``` (si vous avez utilisé *make install*)
 
-Les arguments suivants sont aussi supportés :
+Les arguments suivants sont supportés :
 
 - ```--import [URL]```: importer une histoire dans la librairie
 - ```--export [id] [output_type] [target]```: exporter l'histoire "id" vers le fichier donné
@@ -137,15 +137,20 @@ Les fichiers de test seront:
 
 Nécessaires :
 
-- ```libs/nikiroo-utils-sources.jar```: quelques utilitaires partagés
 - [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): une librairie sympathique pour convertir du texte depuis/vers beaucoup de formats ; utilisée ici pour la partie HTML
 - [```libs/jsoup-sources.jar```](https://jsoup.org/): une libraririe pour parser du HTML
+- [```libs/JSON-java-20190722-sources.jar```](https://github.com/stleary/JSON-java): une libraririe pour parser du JSON
 
 Optionnelles :
 
 - [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): une petite librairie qui offre des widgets en mode TUI
 - [```pandoc```](http://pandoc.org/): pour générer les man pages depuis les fichiers README
 
+Submodules:
+
+- ```src/be/nikiroo/utils```: quelques utilitaires partagés depuis [https://github.com/nikiroo/nikiroo-utils.git](https://github.com/nikiroo/nikiroo-utils.git) -- branche ```subtree```
+- ```src/be/nikiroo/fanfix```: le code principal, sur le même dépôt mais dans la branche ```subtree```
+
 Rien d'autre, si ce n'est Java 1.6+.
 
 À noter : ```make libs``` exporte ces librairies dans le répertoire src/.