json lib fix jar

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index bc003c73634e203d234cf8c5aba4e6daf7699c6b..ceada12a0e0dd1ab1a1ba0239af3ec274b3a4f9d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,8 +12,8 @@ Fanfix is a small Java program that can download stories from some supported web
 - ```fanfix``` --read-url [*URL*] ([*chapter number*])
 - ```fanfix``` --search
 - ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*])
-- ```fanfix``` --tag
-- ```fanfix``` --tag [*index 1*]... (page [*page*]) (item [*item*])
+- ```fanfix``` --search-tag
+- ```fanfix``` --search-tag [*index 1*]... (page [*page*]) (item [*item*])
 - ```fanfix``` --list
 - ```fanfix``` --set-reader [*GUI* | *TUI* | *CLI*]
 - ```fanfix``` --server [*key*] [*port*]
@@ -29,7 +29,7 @@ Fanfix is a small Java program that can download stories from some supported web
 
 ![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
 
-A screenshots cgallery an be found [here](screenshots/README.md).
+A screenshots gallery can be found [here](screenshots/README.md).
 
 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...).
 
@@ -46,11 +46,11 @@ Currently, the following websites are supported:
 
 - http://FimFiction.net/: fan fictions devoted to the My Little Pony show
 - 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
+- http://mangahub.io/: a well filled repository of mangas (English)
 - https://e621.net/: a Furry website supporting comics, including MLP
 - https://sofurry.com/: same thing, but story-oriented
 - https://e-hentai.org/: done upon request (so, feel free to ask for more websites!)
-- https://www.manga-lel.com/: a website offering a lot of mangas (in French)
+- http://mangas-lecture-en-ligne.fr/: a website offering a lot of mangas (in French)
 
 ### Support file types
 
@@ -120,6 +120,21 @@ There are some unit tests you can run, too:
 
 ```./configure.sh && make build test run-test```
 
+If you run the unit tests, note that some flag files can impact them:
+
+- ```test/VERBOSE```      : enable verbose mode
+- ```test/OFFLINE```      : to forbid any downloading
+- ```test/URLS```         : to allow testing URLs
+- ```test/FORCE_REFRESH```: to force a clear of the cache
+
+Note that ```test/CACHE``` can be kept, as it will contain all internet related files you need (if you allow URLs, run the test once which will populate the CACHE then go OFFLINE, it will still work).
+
+The test files will be:
+
+- ```test/*.url```  : URL to download in text format, content = URL
+- ```test/*.story```: text mode story, content = story
+
+
 ### Dependant libraries (included)
 
 Required: