X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;fp=README.md;h=43a0f40687d0fdd6caff18f7c4dd5c7eba3fa16b;hp=7e7c3b9e22e8ad15648b99d4de2dfb76c89bfeb0;hb=966d62609ff6b19a20f8aa60506cd477c51fe5aa;hpb=14598aeffd3b5097a6ca04497e1ac98a08ae85f6 diff --git a/README.md b/README.md index 7e7c3b9..43a0f40 100644 --- a/README.md +++ b/README.md @@ -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: