| LEFT | RIGHT |
| 1 Adblock Plus for Chrome, Opera and Safari | 1 Adblock Plus for Chrome, Opera and 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 Safari. 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) | 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 one of the following commands in the project directory, depending on your | 22 Run one of the following commands in the project directory, depending on your |
| 23 target platform: | 23 target platform: |
| 24 | 24 |
| 25 ./build.py -t chrome build -k adblockpluschrome.pem | 25 ./build.py -t chrome build -k adblockpluschrome.pem |
| 26 ./build.py -t safari build -k adblockplussafari.pem | |
| 27 ./build.py -t edge build | 26 ./build.py -t edge build |
| 28 | 27 |
| 29 This will create a build with a name in the form | 28 This will create a build with a name in the form |
| 30 _adblockpluschrome-1.2.3.nnnn.crx_ or _adblockplussafari-1.2.3.nnnn.safariextz_ | 29 _adblockpluschrome-1.2.3.nnnn.crx_ or _adblockplusedge-1.2.3.nnnn.appx_. |
| 31 or adblockplusedge-1.2.3.nnnn.appx. | |
| 32 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 |
| 33 will be created automatically if the file doesn't exist. Safari on the other | 31 will be created automatically if the file doesn't exist. |
| 34 hand always requires a valid developer certificate, you need to get one in the | |
| 35 Apple Developer Center first. _adblockplussafari.pem_ should contain the private | |
| 36 key for your developer certificate, the developer certificate itself as well as | |
| 37 all the certificates it was signed with (Apple's root certificate and | |
| 38 intermediate certificates) in PEM format - in that order. | |
| 39 | 32 |
| 40 ### Development environment | 33 ### Development environment |
| 41 | 34 |
| 42 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 |
| 43 development environment. For that run one of the following commands: | 36 development environment. For that run one of the following commands: |
| 44 | 37 |
| 45 ./build.py -t chrome devenv | 38 ./build.py -t chrome devenv |
| 46 ./build.py -t safari devenv | 39 ./build.py -t edge devenv |
| 47 | 40 |
| 48 This will create a _devenv.platform_ directory in the repository. In Chrome you | 41 This will create a _devenv.platform_ directory in the repository. In Chrome you |
| 49 should load _devenv.chrome_ as an unpacked extension directory. After making | 42 should load _devenv.chrome_ as an unpacked extension directory. After making |
| 50 changes to the source code re-run the command to update the development | 43 changes to the source code re-run the command to update the development |
| 51 environment, the extension should reload automatically after a few seconds. | 44 environment, the extension should reload automatically after a few seconds. |
| 52 | 45 |
| 53 In Safari you should load _devenv.safari/adblockplussafari.safariextension_ as | 46 For Edge you should load _devenv.edge/Extension_ as an unpacked extension |
| 54 unpacked extension directory. After making changes to the source code re-run the | 47 directory. Edge build does not automatically detect changes, so after |
| 55 command to update the development environment. You will still need to reload the | 48 rebuilding the extension you should manually force reloading it in Edge by |
| 56 extension explicitly in the Extension Builder, Safari currently doesn't allow | 49 hitting the _Reload Extension_ button. |
| 57 automating this action. | |
| 58 | |
| 59 In Edge you should load _devenv.chrome_ as unpacked extension directory. After | |
| 60 rebuilding the extension you should usually force reloading it in Edge. | |
| 61 | 50 |
| 62 Running the unit tests | 51 Running the unit tests |
| 63 ---------------------- | 52 ---------------------- |
| 64 | 53 |
| 65 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_ |
| 66 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 |
| 67 extension's Options page, open the JavaScript Console and type in: | 56 extension's Options page, open the JavaScript Console and type in: |
| 68 | 57 |
| 69 location.href = "qunit/index.html"; | 58 location.href = "qunit/index.html"; |
| 70 | 59 |
| 71 The unit tests will run automatically once the page loads. | 60 The unit tests will run automatically once the page loads. |
| LEFT | RIGHT |