Merge commit '77d3a60869e7a780c6ae069e51530e1eacece5e2'

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index 6acc3d17bc4c34042e8894edef844c13cd698148..43a0f40687d0fdd6caff18f7c4dd5c7eba3fa16b 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*]
@@ -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: