X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;h=f66be31a85fda8501b02eda5a08f94d766d15e8c;hp=571de10734b5f6a9634b188045f81a7a509b351a;hb=f0608ab10e762c1aed9608720b97c1901b5e2614;hpb=edd4628984f5f06e955606651fc828ac839f7f43

diff --git a/README.md b/README.md
index 571de10..f66be31 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,17 @@
 
 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))
 
-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 or LaTeX).
+![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...).
 
 To help organize your stories, it can also work as a local library.
 
 In this mode, you can:
-- Import a story from its URL (or even another file)
-- Export a story to a file (.epub or .cbz)
+- 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 in text format in the console
 - Display a story from the local library graphically **by calling a native program to handle it** (though Fanfix can automatically process it into HTML so any browser can open it)
 
@@ -21,6 +23,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
 
@@ -34,6 +37,7 @@ We support a few file types for local story conversion (both as input and as out
   - 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``` being the file you need to open (or select if you want to convert it into something else) -- we only support importing HTML files created by Fanfix or compatible
 
 ## Supported platforms
 
@@ -56,7 +60,7 @@ 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
+- ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command (must be the first option)
 - ```--help```: display the available options
 
 ### Environment variables
@@ -73,6 +77,10 @@ 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
@@ -85,31 +93,43 @@ 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
 - [ ] 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