Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.md

Issue 5648419829841920: Issue 131 - [Document projects consistently] Add a README.md to the adblockpluschrome repository (Closed)
Patch Set: Addressed comments Created Feb. 17, 2015, 1:18 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 Adblock Plus for Chrome, Opera and Safari
2 =========================================
3
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
6 platforms, generic Adblock Plus code will be extracted from other repositories
7 automatically (see _dependencies_ file).
8
9 Building
10 ---------
11
12 ### Requirements
13
14 - [Python 2.x](https://www.python.org)
15 - [The Jinja2 module](http://jinja.pocoo.org/docs)
16 - [The PIL module](http://www.pythonware.com/products/pil/)
17 - For signed Chrome and Opera builds: [M2Crypto module](https://github.com/marti npaljak/M2Crypto)
18 - For signed Safari builds: A [patched version of the xar command line tool](htt ps://github.com/mackyle/xar/)
19
20 ### Building the extension
21
22 Run one of the following commands in the project directory, depending on your
23 target platform:
24
25 ./build.py -t chrome build -k adblockpluschrome.pem
26 ./build.py -t opera build -k adblockplusopera.pem
27 ./build.py -t safari build -k adblockplussafari.pem
28
29 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_.
31 Note that you don't need an existing signing key for Chrome or Opera, a new key
32 will be created automatically if the file doesn't exist. Safari on the other
33 hand always requires a valid developer certificate, you need to get one in the
34 Apple Developer Center first. _adblockplussafari.pem_ should contain the private
35 key for your developer certificate, the developer certificate itself as well as
36 all the certificates it was signed with (Apple's root certificate and
37 intermediate certificates) in PEM format - in that order.
38
39 ### Development environment
40
41 To simplify the process of testing your changes you can create an unpacked
42 development environment. For that run one of the following commands:
43
44 ./build.py -t chrome devenv
45 ./build.py -t opera devenv
46 ./build.py -t safari devenv
47
48 This will create a _devenv_ directory in the repository. In Chrome and Opera you
49 should load it as an unpacked extension directory. After making changes to the
50 source code re-run the command to update the development environment, the
51 extension should reload automatically after a few seconds.
52
53 In Safari you should load _devenv/adblockplussafari.safariextension_ as unpacked
54 extension directory. After making changes to the source code re-run the command
55 to update the development environment. You will still need to reload the
56 extension explicitly in the Extension Builder, Safari currently doesn't allow
57 automating this action.
58
59 Running the unit tests
60 ----------------------
61
62 To verify your changes you can use the unit test suite located in the _qunit_
63 directory of the repository. In order to run the unit tests go to the
64 extension's Options page, open the JavaScript Console and type in:
65
66 location.href = "qunit/index.html";
67
68 The unit tests will run automatically once the page loads.
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld