Delta Between Two Patch Sets: README.md
Issue 5987679581765632:
Issue 1288 - Add basic usage instructions to the README (Closed)
Left Patch Set:
Created Sept. 2, 2014, 7:23 a.m.
Right Patch Set: Emphasize the ineptitude of DefaultWebRequest et. al. more
Created Sept. 2, 2014, 1:29 p.m.
| Left: | ||
| Right: |
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with change/comment
|
« no previous file
|
no next file »
|
no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| LEFT | RIGHT |
|---|---|
| 1 libadblockplus | 1 libadblockplus |
| 2 ============== | 2 ============== |
| 3 | 3 |
| 4 A C++ library offering the core functionality of Adblock Plus. | 4 A C++ library offering the core functionality of Adblock Plus. |
| 5 | 5 |
| 6 libadblockplus is still work in progress, at an early stage. | 6 libadblockplus is still work in progress, at an early stage. |
| 7 | 7 |
| 8 Building | 8 Building |
| 9 -------- | 9 -------- |
| 10 | 10 |
| (...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 72 instance and pass some information about your | 72 instance and pass some information about your |
| 73 application to it. | 73 application to it. |
| 74 | 74 |
| 75 AppInfo appInfo; | 75 AppInfo appInfo; |
| 76 appInfo.name = "awesomewebfilter"; | 76 appInfo.name = "awesomewebfilter"; |
| 77 appInfo.version = "0.1"; | 77 appInfo.version = "0.1"; |
| 78 appInfo.locale = "en-US"; | 78 appInfo.locale = "en-US"; |
| 79 JsEngine jsEngine(appInfo); | 79 JsEngine jsEngine(appInfo); |
| 80 | 80 |
| 81 `JsEngine` needs to store files, make web requests and write log messages. This | 81 `JsEngine` needs to store files, make web requests and write log messages. This |
| 82 works out of the box because it is using | 82 normally works out of the box because it is using |
|
Wladimir Palant
2014/09/02 13:27:34
"This somewhat works" :)
Or just insert "normally
Felix Dahlke
2014/09/02 13:30:01
Done.
| |
| 83 [`DefaultFileSystem`](https://adblockplus.org/docs/libadblockplus/class_adblock_ plus_1_1_default_file_system.html), | 83 [`DefaultFileSystem`](https://adblockplus.org/docs/libadblockplus/class_adblock_ plus_1_1_default_file_system.html), |
| 84 [`DefaultWebRequest`](https://adblockplus.org/docs/libadblockplus/class_adblock_ plus_1_1_default_web_request.html) | 84 [`DefaultWebRequest`](https://adblockplus.org/docs/libadblockplus/class_adblock_ plus_1_1_default_web_request.html) |
| 85 and | 85 and |
| 86 [`DefaultLogSystem`](https://adblockplus.org/docs/libadblockplus/class_adblock_p lus_1_1_default_log_system.html) | 86 [`DefaultLogSystem`](https://adblockplus.org/docs/libadblockplus/class_adblock_p lus_1_1_default_log_system.html) |
| 87 by default. | 87 by default. |
| 88 | 88 |
| 89 Depending on your application and platform, you might want to supply your own | 89 Depending on your application and platform, you might want to supply your own |
| 90 implementations for these - see | 90 implementations for these - see |
| 91 [`FilterEngine::SetFileSystem`](https://adblockplus.org/docs/libadblockplus/clas s_adblock_plus_1_1_js_engine.html#a979e9bde78499dab9f5e3aacc5155f40), | 91 [`FilterEngine::SetFileSystem`](https://adblockplus.org/docs/libadblockplus/clas s_adblock_plus_1_1_js_engine.html#a979e9bde78499dab9f5e3aacc5155f40), |
| 92 [`FilterEngine::SetWebRequest`](https://adblockplus.org/docs/libadblockplus/clas s_adblock_plus_1_1_js_engine.html#a290a03b86137a56d7b2f457f03c77504) | 92 [`FilterEngine::SetWebRequest`](https://adblockplus.org/docs/libadblockplus/clas s_adblock_plus_1_1_js_engine.html#a290a03b86137a56d7b2f457f03c77504) |
| (...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 190 | 190 |
| 191 ### Unix | 191 ### Unix |
| 192 | 192 |
| 193 The shell is automatically built by `make`, you can run it as follows: | 193 The shell is automatically built by `make`, you can run it as follows: |
| 194 | 194 |
| 195 build/out/abpshell | 195 build/out/abpshell |
| 196 | 196 |
| 197 ### Windows | 197 ### Windows |
| 198 | 198 |
| 199 Just run the project *abpshell*. | 199 Just run the project *abpshell*. |
| LEFT | RIGHT |
« no previous file
|
no next file »
|
Toggle Intra-line Diffs ('i')
|
Expand Comments ('e')
|
Collapse Comments ('c')
|
Toggle Comments ('s')
