X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=4e216225ba3e8cce59e604baf843444f37bc886e;hb=10d558d2429c984327f9e5a16933fefe5cc37314;hp=03f2ce60e521a91426135613cb4659e5531772b5;hpb=b4dc6ab518ded2dd92e4cbb02ac615b1d57e8e6d;p=fanfix.git

diff --git a/README.md b/README.md
index 03f2ce6..4e21622 100644
--- a/README.md
+++ b/README.md
@@ -28,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)
@@ -39,7 +39,7 @@ 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.
 
-It has only been tested on Linux and Windows for now, but feel free to inform me if you try it on another system.
+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.
 
@@ -65,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
 
@@ -89,20 +89,27 @@ Currently missing, but either in progress or planned:
   - [x] Make one
   - [x] Make it run when no args passed
   - [x] Fix the UI, it is ugly
-  - [ ] Work on the UI thread is BAD
+  - [x] Work on the UI thread is BAD
   - [ ] Allow export
+  - [x] Allow delete/refresh
   - [ ] 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
   - [x] i18n system in place
   - [x] Make use of it
-  - [x] Use it for all user output (some WIP remains)
+  - [x] Use it for most user ouput
+  - [ ] Use it for all user output
   - [ ] French translation
 - [ ] 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
+- [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