From: Niki Roo Date: Sun, 19 Apr 2020 08:09:07 +0000 (+0200) Subject: readme/changelog X-Git-Tag: fanfix-swing-0.0.1~14 X-Git-Url: https://git.nikiroo.be/?a=commitdiff_plain;h=93ddcda45485e9d20ccdc858a984a7214279e122;p=fanfix-swing.git readme/changelog --- diff --git a/README-fr.md b/README-fr.md new file mode 100644 index 00000000..b366a9ed --- /dev/null +++ b/README-fr.md @@ -0,0 +1,106 @@ +[English](README.md) Français + +# Fanfix-swing + +Fanfix-swing est un programme qui offre une interface graphique (en java Swing) à la librairie de téléchargement de comics/histoires/mangas [Fanfix](https://github.com/nikiroo/fanfix). + +## Synopsis + +- ```fanfix-swing``` + +## Description + +(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 x.x.x.) + +![Main GUI](screenshots/fanfix-x.x.x.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 : + +- 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 **nativement** ou **en appelant un programme natif pour lire le fichier** + +### Sites supportés + +Pour le moment, les sites suivants sont supportés : + +- http://FimFiction.net/ : fanfictions dévouées à la série My Little Pony +- 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 +- http://mangahub.io/ : un site répertoriant une quantité non négligeable de mangas (English) +- 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 ! +- http://mangas-lecture-en-ligne.fr/ : un site proposant beaucoup de mangas, en français + +### Types de fichiers supportés + +Nous supportons les types de fichiers suivants (aussi bien en entrée qu'en sortie) : + +- epub : les fichiers .epub créés avec Fanfix (nous ne supportons pas les autres fichiers .epub, du moins pour le moment) +- text : les histoires enregistrées en texte (.txt), avec quelques règles spécifiques : + - le titre doit être sur la première ligne + - 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)```) + - les chapitres doivent être déclarés avec ```Chapitre x``` ou ```Chapitre x: NOM DU CHAPTITRE```, où ```x``` est le numéro du chapitre + - une description de l'histoire doit être donnée en tant que chaptire 0 + - 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 +- 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) +- 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) +- 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 + +### Plateformes supportées + +Toute plateforme supportant Java 1.6 devrait suffire. + +Le 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. + +Si vous avez des difficultés pour le compiler avec une version supportée de Java (1.6+), contactez-nous. + +Note pour Windows : nous proposons aussi un laucnher exécutable au format EXE qui vérifie si Java est disponible avant de lancer le programme, et explique comment l'installer si pas. + +## Options + +Vous pouvez démarrer le programme sans paramètres : + +- ```java -jar fanfix-swing.jar``` +- ```fanfix-swing``` (si vous avez utilisé *make install*) + +### Environnement + +Certaines variables d'environnement sont reconnues par le programme : + +- ```LANG=en```: forcer la langue du programme en anglais +- ```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) +- ```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) +- ```DEBUG=1```: force l'option ```DEBUG=true``` du fichier de configuration (pour afficher plus d'information en cas d'erreur) + +## Compilation + +```./configure.sh && make``` + +Vous pouvez aussi importer les sources java dans, par exemple, [Eclipse](https://eclipse.org/), et faire un JAR exécutable depuis celui-ci. + +### Librairies dépendantes (incluses) + +Nécessaires : + +- ```src/be/nikiroo/utils```: quelques utilitaires partagés, inclus en tant que subtree +- ```src/be/nikiroo/fanfix```: la librairie Fanfix sur laquelle tout le programme est basé, inclus en tant que subtree +- [```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 + +Optionnelles : + +- [```pandoc```](http://pandoc.org/): pour générer les man pages depuis les fichiers README, non inclu (pour l'utiliser, il faut que le programme ```pandoc``` soit disponible dans le PATH) + +Rien d'autre, si ce n'est Java 1.6+. + +À noter : ```make libs``` exporte ces librairies dans le répertoire src/. + +## Auteur + +Fanfix a été écrit par Niki Roo + diff --git a/README.md b/README.md new file mode 100644 index 00000000..4ecac6e4 --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +English [Français](README-fr.md) + +# Fanfix-swing + +Fanfix-swing is a program that offer you a graphical nterface (in java Swing) around the comics/stories/mangas library [Fanfix](https://github.com/nikiroo/fanfix). + +## Synopsis + +- ```fanfix-swing``` + +## Description + +(If you are interested in the recent changes, please check the [Changelog](changelog.md) -- note that starting from version x.x.x, the changelog is checked at startup.) + +![Main GUI](screenshots/fanfix-x.x.x.png?raw=true "Main GUI") + +A screenshots gallery can be found [here](screenshots/README.md). + +It will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text, LaTeX, HTML...). + +To help organize your stories, it can also work as a local library so you can: + +- Import a story from its URL (or just from a file) +- Export a story to a file (in any of the supported output types) +- Display a story from the local library **natively** or **by calling a native program to handle it** + +### Supported websites + +Currently, the following websites are supported: + +- http://FimFiction.net/: fan fictions devoted to the My Little Pony show +- http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games +- http://mangahub.io/: a well filled repository of mangas (English) +- https://e621.net/: a Furry website supporting comics, including MLP +- https://sofurry.com/: same thing, but story-oriented +- https://e-hentai.org/: done upon request (so, feel free to ask for more websites!) +- http://mangas-lecture-en-ligne.fr/: a website offering a lot of mangas (in French) + +### Support file types + +We support a few file types for local story conversion (both as input and as output): + +- epub: .epub files created by this program (we do not support "all" .epub files, at least for now) +- text: local stories encoded in plain text format, with a few specific rules: + - the title must be on the first line + - the author (preceded by nothing, ```by ``` or ```©```) must be on the second line, possibly with the publication date in parenthesis (i.e., ```By Unknown (3rd October 1998)```) + - chapters must be declared with ```Chapter x``` or ```Chapter x: NAME OF THE CHAPTER```, where ```x``` is the chapter number + - a description of the story must be given as chapter number 0 + - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension +- info_text: contains the same information as the text format, but with a companion .info file to store some metadata (the .info file is supposed to be created by Fanfix or compatible with it) +- cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously) +- html: HTML files that you can open with any browser; note that it will create a directory structure with ```index.html``` as the main file -- we only support importing HTML files created by Fanfix + +### Supported platforms + +Any platform with at lest Java 1.6 on it should be ok. + +It has been tested on Linux (Debian, Slackware, Ubuntu), MacOS X and Windows for now, but feel free to inform us if you try it on another system. + +If you have any problems to compile it with a supported Java version (1.6+), please contact us. + +Note for Windows : we also offer a launcher in EXE format that checks if Java is available before starting the program, and helps you install it if not. + +## Options + +You can start the program without parameters: + +- ```java -jar fanfix-swing.jar``` +- ```fanfix-swing``` (if you used *make install*) + +### Environment + +Some environment variables are recognized by the program: + +- ```LANG=en```: force the language to English +- ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed) +- ```NOUTF=1```: try to fallback to non-unicode values when possible (can have an impact on the resulting files, not only on user messages) +- ```DEBUG=1```: force the ```DEBUG=true``` option of the configuration file (to show more information on errors) + +## Compilation + +```./configure.sh && make``` + +You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there. + +### Dependant libraries (included) + +Required: + +- ```src/be/nikiroo/utils```: some shared utility functions, included as a subtree +- ```src/be/nikiroo/fanfix```: the fanfix library upon which all the program is based, included as a subtree +- [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; used here for HTML +- [```libs/jsoup-sources.jar```](https://jsoup.org/): a library to parse HTML + +Optional: + +- [```pandoc```](http://pandoc.org/): to generate the man pages from the README files (to use it, ```pandoc``` must be available as program in the PATH) + +Nothing else but Java 1.6+. + +Note that calling ```make libs``` will export the libraries into the src/ directory. + +## Author + +Fanfix was written by Niki Roo + diff --git a/changelog-fr.md b/changelog-fr.md new file mode 100644 index 00000000..c9d9bc9a --- /dev/null +++ b/changelog-fr.md @@ -0,0 +1,9 @@ +# Fanfix-swing + +# Version WIP + +- new: première version +- new: support fichier (File -> Import File) +- new: support internet (File -> Download) +- new: capable d'afficher les histoires avec un programme natif + diff --git a/changelog.md b/changelog.md new file mode 100644 index 00000000..982c51df --- /dev/null +++ b/changelog.md @@ -0,0 +1,9 @@ +# Fanfix-swing + +# Version WIP + +- new: first version +- new: file support (File -> Import File) +- new: online support (File -> Download) +- new: able to display stories with a native program + diff --git a/screenshots/README-fr.md b/screenshots/README-fr.md new file mode 100644 index 00000000..61a4fb01 --- /dev/null +++ b/screenshots/README-fr.md @@ -0,0 +1,20 @@ +# Fanfix + +## Screenshots + +Cette gallerie reprend des screenshots de plusieurs versions de Fanfix, mais les versions les plus récentes sont affichées en premier. + +TODO: update with screenshots from fanfix-swing!! + +### Version 2.0.0 + +![Fenêtre principale](fanfix-swing-2.0.0-gui-library.png) + +![Propriétés d'une histoire](fanfix-swing-2.0.0-gui-properties.png) + +![Menu](fanfix-swing-2.0.0-gui-menu.png) + +### Version 1.3.2 + +![Fenêtre principale](fanfix-swing-1.3.2.png) + diff --git a/screenshots/README.md b/screenshots/README.md new file mode 100644 index 00000000..8085247c --- /dev/null +++ b/screenshots/README.md @@ -0,0 +1,20 @@ +# Fanfix + +## Screenshots + +This screenshots gallery shows screenshots of different versions of Fanfix, but shows the more recent ones on top. + +TODO: update with screenshots from fanfix-swing!! + +### Version 2.0.0 + +![Main window](fanfix-swing-2.0.0-gui-library.png) + +![Properties page](fanfix-swing-2.0.0-gui-properties.png) + +![Menu](fanfix-swing-2.0.0-gui-menu.png) + +### Version 1.3.2 + +![Main window](fanfix-swing-1.3.2.png) +