OLD | NEW |
1 Adblock Plus core | 1 Adblock Plus core |
2 ================= | 2 ================= |
3 | 3 |
4 This repository contains the generic Adblock Plus code that's shared between | 4 This repository contains the generic Adblock Plus code that's shared between |
5 platforms. This repository is not designed to be used directly, but instead to | 5 platforms. This repository is not designed to be used directly, but instead to |
6 serve as a dependency for `adblockplus`, `adblockpluschrome` and | 6 serve as a dependency for `adblockplus`, `adblockpluschrome` and |
7 `libadblockplus`. | 7 `libadblockplus`. |
8 | 8 |
9 Compiling C++ code | 9 Compiling C++ code |
10 ------------------ | 10 ------------------ |
11 | 11 |
12 ### Purpose | 12 ### Purpose |
13 | 13 |
14 In order to improve performance and memory usage, some of the code (located | 14 In order to improve performance and memory usage, some of the code (located |
15 inside the `compiled` directory) is written in C++ and compiled to JavaScript | 15 inside the `compiled` directory) is written in C++ and compiled to JavaScript |
16 via Empscripten. | 16 via Empscripten. |
17 | 17 |
18 ### Requirements | 18 ### Requirements |
19 | 19 |
20 * [Emscripten 1.35.0](https://github.com/kripken/emscripten) | 20 * [Emscripten 1.37.3](https://github.com/kripken/emscripten) |
21 * [Python 2.7](https://www.python.org) | 21 * [Python 2.7](https://www.python.org) |
22 * [Node.js 6 or higher](https://nodejs.org/en/) | 22 * [Node.js 6 or higher](https://nodejs.org/en/) |
23 | 23 |
24 ### Running Emscripten | 24 ### Running Emscripten |
25 | 25 |
26 *Note*: The `compile` script will likely be replaced by a more elaborate | 26 *Note*: The `compile` script will likely be replaced by a more elaborate |
27 solution later. | 27 solution later. |
28 | 28 |
29 Before you start make sure to edit the `compile` script and make sure that | 29 Before you start make sure to edit the `compile` script and make sure that |
30 `EMSCRIPTEN_PATH` constant at the top of it points to your Emscripten install. | 30 `EMSCRIPTEN_PATH` constant at the top of it points to your Emscripten install. |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
64 internals, we have to require a specific Emscripten version. | 64 internals, we have to require a specific Emscripten version. |
65 | 65 |
66 Running the unit tests | 66 Running the unit tests |
67 ---------------------- | 67 ---------------------- |
68 | 68 |
69 You first need to run `npm install` in the repository directory in order to | 69 You first need to run `npm install` in the repository directory in order to |
70 install the required dependencies. After that you can run `npm test` which will | 70 install the required dependencies. After that you can run `npm test` which will |
71 execute all tests in the `test` directory of the repository. You can also | 71 execute all tests in the `test` directory of the repository. You can also |
72 specify specific test files on the command line, e.g. | 72 specify specific test files on the command line, e.g. |
73 `npm test test/synchronizer.js`. | 73 `npm test test/synchronizer.js`. |
OLD | NEW |