README/changelog update
authorNiki Roo <niki@nikiroo.be>
Fri, 15 Mar 2019 16:33:25 +0000 (17:33 +0100)
committerNiki Roo <niki@nikiroo.be>
Fri, 15 Mar 2019 16:33:25 +0000 (17:33 +0100)
README-fr.md
README.md
changelog-fr.md
changelog.md
screenshots/README-fr.md [new file with mode: 0644]
screenshots/README.md [new file with mode: 0644]

index be6de409ba920454cb05fa5b93a3a10837e59a5e..ea08716c7401ce86adefb04056edd7db02406a28 100644 (file)
@@ -11,7 +11,7 @@ Fanfix est un petit programme Java qui peut télécharger des histoires sur inte
 - ```fanfix``` --read [*id*] ([*chapter number*])
 - ```fanfix``` --read-url [*URL*] ([*chapter number*])
 - ```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,10 +23,10 @@ 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")
 
+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 :
index 9c1c5db547af572ff100293208adefa5334eb563..07af0d0c1bd673246a7697d2c872058db0cea7b3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ Fanfix is a small Java program that can download stories from some supported web
 - ```fanfix``` --read [*id*] ([*chapter number*])
 - ```fanfix``` --read-url [*URL*] ([*chapter number*])
 - ```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,10 +23,10 @@ Fanfix is a small Java program that can download stories from some supported web
 
 (A [TODO list](TODO.md) is also available to know what is expected to come in the future.)
 
-TODO: new screenshots + TUI screenshots
-
 ![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
 
+A screenshots cgallery an 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:
index c3fb27c65f421fde85d301ad9f2c64d80c59f32c..da42d9851e3847fc91aacaf74303a5dccb84635c 100644 (file)
@@ -2,8 +2,13 @@
 
 # Version WIP
 
+- gui: new Properties page for stories
+- tui: now working well enough to be considered stable
 - remote: fix setSourceCover (was not seen by client)
+- remote: can now import local files into a remote library
+- remote: better perfs
 - fix: deadlock in some rare cases (nikiroo-utils)
+- fix: the resume was not visible in some cases
 
 # Version 1.8.1
 
index f60a069084afca815b0cb36d0dbe3f2721025d8c..c23b53144655cfae9b54d96a18ec4570fc1bb974 100644 (file)
@@ -2,8 +2,13 @@
 
 # Version WIP
 
+- gui: nouvelle page pour voir les propriétés d'une histoire
+- tui: fonctionne maintenant assez bien que pour être déclaré stable
 - remote: fix de setSourceCover (ce n'était pas vu par le client)
+- remote: on peut maintenant importer un fichier local
+- remote: meilleures perfs
 - fix: deadlock dans certains cas rares (nikiroo-utils)
+- fix: le résumé n'était pas visibe dans certains cas
 
 # Version 1.8.1
 
diff --git a/screenshots/README-fr.md b/screenshots/README-fr.md
new file mode 100644 (file)
index 0000000..a3745b1
--- /dev/null
@@ -0,0 +1,50 @@
+# Fanfix
+
+## Screenshots
+
+Fanfix peut utiliser plusieurs interfaces :
+
+- GUI: une interface basée sur Swing, pour afficher le programme sur votre PC graphiquement
+- TUI: une interface basée sur [jexer](https://gitlab.com/klamonte/jexer/), pour afficher des fenêtre et des boutons en mode texte
+- CLI: une interface purement en lignes de commandes, facile à automatiser dans un script ou pour utiliser dans un terminal texte
+
+Cette gallerie reprend des screenshots de plusieurs versions de Fanfix, mais les versions les plus récentes sont affichées en premier.
+
+### Version 1.9.0
+
+#### GUI
+
+![Fenêtre principale](fanfix-1.9.0-gui-library.png)
+
+![Propriétés d'une histoire](fanfix-1.9.0-gui-properties.png)
+
+![Menu](fanfix-1.9.0-gui-menu.png)
+
+#### TUI
+
+![Fenêtre principale](fanfix-1.9.0-tui-library.png)
+
+![Propriétés d'une histoire](fanfix-1.9.0-tui-properties.png)
+
+![Menu](fanfix-1.9.0-tui-menu.png)
+
+#### CLI
+
+![Fenêtre principale](fanfix-1.9.0-cli-library.png)
+
+![Propriétés d'une histoire](fanfix-1.9.0-cli-properties.png)
+
+![Menu](fanfix-1.9.0-cli-menu.png)
+
+### Version 1.3.2
+
+#### GUI
+
+![Fenêtre principale](fanfix-1.3.2.png)
+
+### Version 1.0.0
+
+#### GUI
+
+![Fenêtre principale](fanfix-1.0.0.png)
+
diff --git a/screenshots/README.md b/screenshots/README.md
new file mode 100644 (file)
index 0000000..aab6762
--- /dev/null
@@ -0,0 +1,49 @@
+# Fanfix
+
+## Screenshots
+
+Fanfix can use different interfaces:
+
+- GUI: a Swing-based interface to display on your desktop
+- TUI: a [jexer](https://gitlab.com/klamonte/jexer/)-based interface to display in text mode, but still with window, buttons and other widgets
+- CLI: a fully automated CLI mode that can be used for scripts or to read on a terminal screen
+
+This screenshots gallery shows screenshots of different versions of Fanfix, but shows the more recent ones on top.
+
+### Version 1.9.0
+
+#### GUI
+
+![Main window](fanfix-1.9.0-gui-library.png)
+
+![Properties page](fanfix-1.9.0-gui-properties.png)
+
+![Menu](fanfix-1.9.0-gui-menu.png)
+
+#### TUI
+
+![Main window](fanfix-1.9.0-tui-library.png)
+
+![Properties page](fanfix-1.9.0-tui-properties.png)
+
+![Menu](fanfix-1.9.0-tui-menu.png)
+
+#### CLI
+
+![Main window](fanfix-1.9.0-cli-library.png)
+
+![Properties page](fanfix-1.9.0-cli-properties.png)
+
+![Menu](fanfix-1.9.0-cli-menu.png)
+
+### Version 1.3.2
+
+#### GUI
+
+![Main window](fanfix-1.3.2.png)
+
+### Version 1.0.0
+
+#### GUI
+
+![Main window](fanfix-1.0.0.png)