Left: | ||
Right: |
LEFT | RIGHT |
---|---|
1 Adblock Plus for Chrome and Opera | 1 Adblock Plus for Chrome, Opera and Edge |
kzar
2016/12/16 10:40:14
Please change this title to add Edge.
| |
2 ================================= | 2 ======================================= |
3 | 3 |
4 This repository contains the platform-specific Adblock Plus source code for | 4 This repository contains the platform-specific Adblock Plus source code for |
5 Chrome, Opera and Edge. It can be used to build Adblock Plus for these | 5 Chrome, Opera and Edge. It can be used to build Adblock Plus for these |
6 platforms, generic Adblock Plus code will be extracted from other repositories | 6 platforms, generic Adblock Plus code will be extracted from other repositories |
7 automatically (see _dependencies_ file). | 7 automatically (see _dependencies_ file). |
8 | 8 |
9 Building | 9 Building |
10 --------- | 10 --------- |
11 | 11 |
12 ### Requirements | 12 ### Requirements |
13 | 13 |
14 - [Mercurial](https://www.mercurial-scm.org/) or [Git](https://git-scm.com/) (wh ichever you used to clone this repository) | 14 - [Mercurial](https://www.mercurial-scm.org/) or [Git](https://git-scm.com/) (wh ichever you used to clone this repository) |
15 - [Python 2.7](https://www.python.org) | 15 - [Python 2.7](https://www.python.org) |
16 - [The Jinja2 module](http://jinja.pocoo.org/docs) (>= 2.8) | 16 - [The Jinja2 module](http://jinja.pocoo.org/docs) (>= 2.8) |
17 - [The PIL module](http://www.pythonware.com/products/pil/) | 17 - [The PIL module](http://www.pythonware.com/products/pil/) |
18 - For signed builds: [PyCrypto module](https://www.dlitz.net/software/pycrypto/) | 18 - For signed builds: [PyCrypto module](https://www.dlitz.net/software/pycrypto/) |
19 | 19 |
20 ### Building the extension | 20 ### Building the extension |
21 | 21 |
22 Run the following command in the project directory: | 22 Run one of the following commands in the project directory, depending on your |
kzar
2016/12/16 10:40:14
There are more than one commands now, but this sti
| |
23 target platform: | |
23 | 24 |
24 ./build.py -t chrome build -k adblockpluschrome.pem | 25 ./build.py -t chrome build -k adblockpluschrome.pem |
25 ./build.py -t edge build | 26 ./build.py -t edge build |
26 | 27 |
27 This will create a build with a name in the form | 28 This will create a build with a name in the form |
28 _adblockpluschrome-1.2.3.nnnn.crx_ or adblockplusedge-1.2.3.nnnn.appx. | 29 _adblockpluschrome-1.2.3.nnnn.crx_ or _adblockplusedge-1.2.3.nnnn.appx_. |
29 Note that you don't need an existing signing key for Chrome, a new key | 30 Note that you don't need an existing signing key for Chrome, a new key |
30 will be created automatically if the file doesn't exist. | 31 will be created automatically if the file doesn't exist. |
31 | 32 |
32 ### Development environment | 33 ### Development environment |
33 | 34 |
34 To simplify the process of testing your changes you can create an unpacked | 35 To simplify the process of testing your changes you can create an unpacked |
35 development environment. For that run the following command: | 36 development environment. For that run one of the following commands: |
kzar
2016/12/16 10:40:14
Same here, there are now multiple commands.
| |
36 | 37 |
37 ./build.py -t chrome devenv | 38 ./build.py -t chrome devenv |
38 ./build.py -t edge devenv | 39 ./build.py -t edge devenv |
39 | 40 |
40 This will create a _devenv.chrome_ directory in the repository. In Chrome you | 41 This will create a _devenv.platform_ directory in the repository. In Chrome you |
kzar
2016/12/16 10:40:14
This is wrong now, since it will create either a _
| |
41 should load the directory as an unpacked extension. After making changes to the | 42 should load _devenv.chrome_ as an unpacked extension directory. After making |
42 source code re-run the command to update the development environment, the | 43 changes to the source code re-run the command to update the development |
43 extension should reload automatically after a few seconds. | 44 environment, the extension should reload automatically after a few seconds. |
44 | 45 |
45 For Edge you should load _devenv.edge/Extension_ as an unpacked extension direct ory. After | 46 For Edge you should load _devenv.edge/Extension_ as an unpacked extension |
kzar
2016/12/16 10:40:14
Nit: This line is too long, please wrap at 80 char
| |
46 rebuilding the extension you should usually force reloading it in Edge. | 47 directory. Edge build does not automatically detect changes, so after |
kzar
2016/12/16 10:40:14
Please be a bit more specific here about when + ho
| |
48 rebuilding the extension you should manually force reloading it in Edge by | |
49 hitting the _Reload Extension_ button. | |
47 | 50 |
48 Running the unit tests | 51 Running the unit tests |
49 ---------------------- | 52 ---------------------- |
50 | 53 |
51 To verify your changes you can use the unit test suite located in the _qunit_ | 54 To verify your changes you can use the unit test suite located in the _qunit_ |
52 directory of the repository. In order to run the unit tests go to the | 55 directory of the repository. In order to run the unit tests go to the |
53 extension's Options page, open the JavaScript Console and type in: | 56 extension's Options page, open the JavaScript Console and type in: |
54 | 57 |
55 location.href = "qunit/index.html"; | 58 location.href = "qunit/index.html"; |
56 | 59 |
57 The unit tests will run automatically once the page loads. | 60 The unit tests will run automatically once the page loads. |
LEFT | RIGHT |