X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=d80d3c5cb7f64afa88bba49195ae1d950d610395;hb=68e2c6d20049d713de1bd31b749450b2f60d8340;hp=eddd55e8aa01b729871cb512825561fb3d909675;hpb=373da363323d3a9263aa6ebd392ca3272b23b412;p=fanfix.git

diff --git a/README.md b/README.md
index eddd55e..d80d3c5 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,11 @@
 
 Fanfix is a small Java program that can download stories from some supported websites and render them offline.
 
-![Main GUI](screenshots/fanfix.png?raw=true "Main GUI")
+(If you are interested in the recent changes, please check the [Changelog](changelog.md) -- note that starting from version 1.4.0, the changelog is checked at startup (unless the option is disabled))
+
+TODO: new screenshots + TUI screenshots
+
+![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
 
 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...).
 
@@ -21,6 +25,7 @@ Currently, the following websites are supported:
 - http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games
 - http://mangafox.me/: a well filled repository of mangas, or, as their website states: most popular manga scanlations read online for free at mangafox, as well as a close-knit community to chat and make friends
 - https://e621.net/: a Furry website supporting comics, including MLP
+- https://sofurry.com/: same thing, but story-oriented
 
 ## A note about file support
 
@@ -57,7 +62,9 @@ The following arguments are also allowed:
 - ```--read [id] ([chapter number])```: read the given story denoted by ID from the library
 - ```--read-url [URL] ([chapter number])```: convert on the fly and read the story denoted by ID, without saving it
 - ```--list```: list the stories present in the library and their associated IDs
-- ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command (must be the first option)
+- ```--set-reader [reader type]```: set the reader type to CLI, TUI or GUI for this command
+- ```--server [port]```: start a story server on this port
+- ```--remote [host] [port]```: contact this server instead of the usual library
 - ```--help```: display the available options
 
 ### Environment variables
@@ -74,10 +81,15 @@ Some environment variables are recognized by the program:
 
 You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there.
 
+There are some unit tests you can run, too:
+
+```./configure.sh && make build test run-test```
+
 ### Dependant libraries (included)
 
 - libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere
 - [libs/unbescape-sources.jar](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; I only use it for HTML
+- [libs/jexer-sources.jar](https://github.com/klamonte/jexer): a small library that offers TUI widgets
 
 Nothing else but Java 1.6+.
 
@@ -86,31 +98,57 @@ Note that calling ```make libs``` will export the libraries into the src/ direct
 ## TODO
 
 Currently missing, but either in progress or planned:
-- [ ] A GUI (work in progress)
+- [ ] Support new websites
+  - [x] YiffStar
+  - [ ] [Two Kinds](http://twokinds.keenspot.com/)
+  - [ ] [Slightly damned](http://www.sdamned.com/)
+  - [ ] Others? Any ideas?
+    - [x] [e-Hentai](https://e-hentai.org/) requested
+- [x] A GUI (work in progress)
   - [x] Make one
   - [x] Make it run when no args passed
   - [x] Fix the UI, it is ugly
   - [x] Work on the UI thread is BAD
   - [x] Allow export
   - [x] Allow delete/refresh
-  - [ ] Show a list of types
+  - [x] Show a list of types
     - [x] ..in the menu
-    - [ ] ..as a screen view
-  - [ ] options screen
+    - [x] ..as a screen view
+  - [x] options screen
 - [ ] A TUI reader
+  - [x] Choose an output (Jexer)
+  - [x] Implement it from --set-reader to the actual window
+  - [x] List the stories
+  - [ ] Fix the UI layout
+  - [x] Status bar
+  - [ ] Real menus
+  - [x] Open a story in the reader and/or natively
+  - [ ] Update the screenshots
+- [ ] Network support
+  - [x] A server that can send the stories
+  - [x] A network implementation of the Library
+  - [ ] Write access to the library (?)
+  - [ ] Access rights (?)
+  - [ ] More tests, especially with the GUI
 - [ ] Check if it can work on Android
+  - [x] First checks: it should work, but with changes
+  - [ ] Adapt work on images :(
+  - [ ] Partial/Conditional compilation
+  - [ ] APK export
 - [ ] Translations
   - [x] i18n system in place
   - [x] Make use of it
-  - [x] Use it for most user ouput
   - [ ] Use it for all user output
   - [ ] French translation
-- [x] Allow lauching a custom application instead of Desktop.start ?
-  - [ ] Make a wrapper for firefox to create a new, empty profile ?
+- [x] Allow lauching a custom application instead of Desktop.start
 - [x] Install a mechanism to handle stories import/export progress update
   - [x] Progress system
   - [x] in support classes (import)
   - [x] in output classes (export)
   - [x] CLI usage of such
   - [x] GUI usage of such
+- [x] Version
+  - [x] Use a version number
+  - [x] Show it in UI
+  - [x] A check-update feature