New website supported on request: e-hentai.org

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index 2f0c95460cc97607f71d964e7c186b3a17b0e6f7..f66be31a85fda8501b02eda5a08f94d766d15e8c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
 
 Fanfix is a small Java program that can download stories from some supported websites and render them offline.
 
-(If you are interested in the recent changes, please check the [Changelog](changelog.md).)
+(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))
 
-![Main GUI](screenshots/fanfix.png?raw=true "Main GUI")
+![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...).
 
@@ -77,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
@@ -89,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