Unified Diff: README.md
Issue 29356103:
Issue 3943 - add support of configuration file
Patch Set: address comments
Created Nov. 22, 2016, 9:20 a.m.
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« no previous file
|
config.json.example » ('j')
|
no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| Index: README.md |
| diff --git a/README.md b/README.md |
| index 70f3f49cade791be9340c06dd9f51a5113b00848..eb2c23ae5ea0c9e36727f3fdd3d77c7f1d8b1070 100644 |
| --- a/README.md |
| +++ b/README.md |
| @@ -17,13 +17,23 @@ Running |
| Execute the following: |
| - ./run.py -b /usr/bin/firefox urls.txt outputdir |
| + ./run.py -b /usr/bin/firefox -l urls.txt -o outputdir |
| This will run the specified Firefox binary to crawl the URLs from `urls.txt` |
| (one URL per line). The resulting data and screenshots will be written to the |
| `outputdir` directory. Firefox will close automatically once all URLs have been |
| processed. |
| +In addition parameters can be loaded from a configuration file. Use -c/--config |
| + `path to json file` and long-named command line parameters as property names, |
| +please take a look at the example `config.json.example`. Command line |
| +parameters passed alongside with config file take precedence. |
| +Example: |
| + ./run.py -c config.json.example -l example.urls |
| + |
| +This is equiualent to |
| + ./run.py -b /usr/bin/firefox -l example.urls -o ../output |
| + |
| Optionally, you can provide the path to the Adblock Plus repository - Adblock |
| Plus will no longer be downloaded then. |
« no previous file with comments
|
« no previous file
|
config.json.example » ('j')
|
no next file with comments »
