X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;h=006ad95f34ebd6c9d0defeb175aff72b9204bccc;hp=6e2d8b00b0e134e9a8c5fc40c2b8acdeff23b29b;hb=d98a29006897a1ae31ff3a039afe9643a48e0704;hpb=333f0e7b5e333e8f6222881ce35398f403fc4121

diff --git a/README.md b/README.md
index 6e2d8b0..006ad95 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 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")
+
 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).
 
 To help organize your stories, it can also work as a local library.
@@ -26,8 +28,8 @@ We support a few file types for local story conversion (both as input and as out
 - 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
+  - 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)
@@ -37,16 +39,17 @@ We support a few file types for local story conversion (both as input and as out
 
 Any platform with at lest Java 1.6 on it should be ok.
 
-If you have any problems to compile it with a supported Java version (1.5 won't work, but you may try to cross-compile or change the Bundle.java class from the utilities; 1.6 and 1.8 have been tested and work), please contact me.
+It has been tested on Linux, MacOS X and Windows for now, but feel free to inform me if you try it on another system.
+
+If you have any problems to compile it with a supported Java version (1.5 won't work, but you may try to cross-compile; 1.6 and 1.8 have been tested and work), please contact me.
 
 ## Usage
 
-You can start the program in CLI mode:
+You can start the program in GUI mode (as in the screenshot on top):
 - ```java -jar fanfix.jar```
 
-__TODO__: offer a GUI mode (work in progress)
 
-The following arguments are allowed:
+The following arguments are also allowed:
 - ```--import [URL]```: import the story at URL into the local library
 - ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file
 - ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed
@@ -62,7 +65,7 @@ Some environment variables are recognized by the program:
 - ```LANG=en```: force the language to English (the only one for now...)
 - ```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)
+- ```DEBUG=1```: force the ```DEBUG=true``` option of the configuration file (to show more information on errors)
 
 ## Compilation
 
@@ -85,13 +88,13 @@ Currently missing, but either in progress or planned:
 - [ ] A GUI (work in progress)
   - [x] Make one
   - [x] Make it run when no args passed
-  - [ ] Fix the UI, it is ugly
+  - [x] Fix the UI, it is ugly
   - [ ] Work on the UI thread is BAD
   - [ ] Allow export
   - [ ] Show a list of types
     - [x] ..in the menu
     - [ ] ..as a screen view
-  - options screen
+  - [ ] options screen
 - [ ] A TUI reader
 - [ ] Check if it can work on Android
 - [ ] Translations
@@ -99,6 +102,7 @@ Currently missing, but either in progress or planned:
   - [x] Make use of it
   - [x] Use it for all user output (some WIP remains)
   - [ ] French translation
-- [ ] Allow lauching a custom application instead of Desktop.star ?
+- [ ] Allow lauching a custom application instead of Desktop.start ?
   - [ ] Make a wrapper for firefox to create a new, empty profile ?
+- [ ] Install a mechanism to handle stories import progress update