try +1
[nikiroo-utils.git] / README-fr.md
CommitLineData
10ccd649 1[English](README.md) Français
eab9e01c
NR
2
3# Fanfix
eab9e01c
NR
4Fanfix est un petit programme Java qui peut télécharger des histoires sur internet et les afficher hors ligne.
5
2953f988
NR
6## Synopsis
7
8- ```fanfix``` --import [*URL*]
9- ```fanfix``` --export [*id*] [*output_type*] [*target*]
10- ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info)
11- ```fanfix``` --read [*id*] ([*chapter number*])
12- ```fanfix``` --read-url [*URL*] ([*chapter number*])
13- ```fanfix``` --list
14- ```fanfix``` --set-reader [*reader type*]
15- ```fanfix``` --server [*key*] [*port*]
16- ```fanfix``` --stop-server [*key*] [*port*]
17- ```fanfix``` --remote [*key*] [*host*] [*port*]
18- ```fanfix``` --help
19
42375f55
NR
20## Description
21
eab9e01c
NR
22(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.)
23
24(Il y a aussi une [TODO list](TODO.md) sur le site parlant du futur du programme.)
25
26TODO: screenshots TUI + Android (+ FR quand traduit)
27
28![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
29
30Le 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...)
31
32Pour vous aider à organiser vos histoires, il peut aussi servir de bibliothèque locale vous permettant :
42375f55 33
eab9e01c
NR
34- d'importer une histoire depuis son URL (ou depuis un fichier)
35- d'exporter une histoire dans un des formats supportés vers un fichier
36- d'afficher une histoire en mode texte
37- 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)
38
2953f988 39### Sites supportés
eab9e01c
NR
40
41Pour le moment, les sites suivants sont supportés :
42375f55 42
eab9e01c
NR
43- http://FimFiction.net/ : fanfictions dévouées à la série My Little Pony
44- http://Fanfiction.net/ : fanfictions venant d'une multitude d'univers différents, depuis les shows télévisés aux livres en passant par les jeux-vidéos
45- http://mangafox.me/ : un site répertoriant une quantité non négligeable de mangas
46- https://e621.net/ : un site Furry proposant des comics, y compris de MLP
47- https://sofurry.com/ : même chose, mais orienté sur les histoires plutôt que les images
48- https://e-hentai.org/ : support ajouté sur demande : n'hésitez pas à demander un site !
49
2953f988 50### Types de fichiers supportés
eab9e01c
NR
51
52Nous supportons les types de fichiers suivants (aussi bien en entrée qu'en sortie) :
42375f55 53
eab9e01c
NR
54- epub : les fichiers .epub créés avec Fanfix (nous ne supportons pas les autres fichiers .epub, du moins pour le moment)
55- text : les histoires enregistrées en texte (.txt), avec quelques règles spécifiques :
42375f55
NR
56 - le titre doit être sur la première ligne
57 - l'auteur (précédé de rien, ```Par ```, ```De ``` ou ```©```) doit être sur la deuxième ligne, optionnellement suivi de la date de publication entre parenthèses (i.e., ```Par Quelqu'un (3 octobre 1998)```)
58 - les chapitres doivent être déclarés avec ```Chapitre x``` ou ```Chapitre x: NOM DU CHAPTITRE```, où ```x``` est le numéro du chapitre
59 - une description de l'histoire doit être donnée en tant que chaptire 0
60 - une image de couverture peut être présente avec le même nom de fichier que l'histoire, mais une extension .png, .jpeg ou .jpg
eab9e01c
NR
61- info_text : fort proche du format texte, mais avec un fichier .info accompagnant l'histoire pour y enregistrer quelques metadata (le fichier de metadata est supposé être créé par Fanfix, ou être compatible avec)
62- cbz : les fichiers .cbz (une collection d'images zipées), de préférence créés avec Fanfix (même si les autres .cbz sont aussi supportés, mais sans la majorité des metadata de Fanfix dans ce cas)
63- html : les fichiers HTML que vous pouvez ouvrir avec n'importe quel navigateur ; remarquez que Fanfix créera un répertoire pour y mettre les fichiers nécessaires, dont un fichier ```index.html``` pour afficher le tout -- nous ne supportons en entrée que les fichiers HTML créés par Fanfix
64
2953f988 65### Plateformes supportées
eab9e01c
NR
66
67Toute plateforme supportant Java 1.6 devrait suffire.
68
69Le programme a été testé sur Linux (Debian, Slackware et Ubuntu), MacOS X et Windows pour le moment, mais n'hésitez pas à nous informer si vous l'essayez sur un autre système.
70
71Si vous avez des difficultés pour le compiler avec une version supportée de Java (1.6+), contactez-nous.
72
2953f988 73## Options
eab9e01c
NR
74
75Vous pouvez démarrer le programme en mode graphique (comme dans le screenshot en haut) :
42375f55 76
eab9e01c 77- ```java -jar fanfix.jar```
2953f988 78- ```fanfix``` (si vous avez utilisé *make install*)
eab9e01c
NR
79
80Les arguments suivants sont aussi supportés :
42375f55 81
eab9e01c
NR
82- ```--import [URL]```: importer une histoire dans la librairie
83- ```--export [id] [output_type] [target]```: exporter l'histoire "id" vers le fichier donné
84- ```--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é
85- ```--read [id] ([chapter number])```: afficher l'histoire "id"
86- ```--read-url [URL] ([chapter number])```: convertir l'histoire et la lire à la volée, sans la sauver
87- ```--list```: lister les histoires presentes dans la librairie et leurs IDs
88- ```--set-reader [reader type]```: changer le type de lecteur pour la commande en cours sur CLI, TUI ou GUI
89- ```--server [key] [port]```: démarrer un serveur d'histoires sur ce port
10ccd649 90- ```--stop-server [key] [port]```: arrêter le serveur distant sur ce port (key doit avoir la même valeur)
eab9e01c
NR
91- ```--remote [key] [host] [port]```: contacter ce server au lieu de la librairie habituelle (key doit avoir la même valeur)
92- ```--help```: afficher la liste des options disponibles
93- ```--version```: retourne la version du programme
94
2953f988 95### Environnement
eab9e01c
NR
96
97Certaines variables d'environnement sont reconnues par le programme :
42375f55 98
eab9e01c
NR
99- ```LANG=en```: forcer la langue du programme en anglais
100- ```CONFIG_DIR=$HOME/.fanfix```: utilise ce répertoire pour les fichiers de configuration du programme (et copie les fichiers de configuration par défaut si besoin)
101- ```NOUTF=1```: essaye d'utiliser des caractères non-unicode quand possible (cela peut avoir un impact sur les fichiers générés, pas uniquement sur les messages à l'utilisateur)
102- ```DEBUG=1```: force l'option ```DEBUG=true``` du fichier de configuration (pour afficher plus d'information en cas d'erreur)
103
104## Compilation
105
106```./configure.sh && make```
107
108Vous pouvez aussi importer les sources java dans, par exemple, [Eclipse](https://eclipse.org/), et faire un JAR exécutable depuis celui-ci.
109
110Quelques tests unitaires sont disponibles :
111
112```./configure.sh && make build test run-test```
113
114### Librairies dépendantes (incluses)
115
116Nécessaires :
42375f55 117
2953f988
NR
118- ```libs/nikiroo-utils-sources.jar```: quelques utilitaires partagés
119- [```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
120- [```libs/jsoup-sources.jar```](https://jsoup.org/): une libraririe pour parser du HTML
eab9e01c
NR
121
122Optionnelles :
42375f55 123
2953f988
NR
124- [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): une petite librairie qui offre des widgets en mode TUI
125- [```pandoc```](http://pandoc.org/): pour générer les man pages depuis les fichiers README
eab9e01c
NR
126
127Rien d'autre, si ce n'est Java 1.6+.
128
129À noter : ```make libs``` exporte ces librairies dans le répertoire src/.
130
42375f55
NR
131## Auteur
132
133Fanfix a été écrit par Niki Roo <niki@nikiroo.be>
134