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

Side by Side Diff: README.md

Issue 29365879: Issue 4616 - Push Edge related changes to the edge bookmark of adblockpluschrome (Closed)
Patch Set: Refresh README.md Created Dec. 14, 2016, 2:05 a.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 | icons/abp-150.png » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Adblock Plus for Chrome and Opera 1 Adblock Plus for Chrome and Opera
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 and Opera. It can be used to build Adblock Plus for these platforms, 5 Chrome, Opera and Edge. It can be used to build Adblock Plus for these
6 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 the following command in the project directory:
kzar 2016/12/16 10:40:14 There are more than one commands now, but this sti
23 23
24 ./build.py -t chrome build -k adblockpluschrome.pem 24 ./build.py -t chrome build -k adblockpluschrome.pem
25 ./build.py -t edge build
25 26
26 This will create a build with a name in the form 27 This will create a build with a name in the form
27 _adblockpluschrome-1.2.3.nnnn.crx_ 28 _adblockpluschrome-1.2.3.nnnn.crx_ or adblockplusedge-1.2.3.nnnn.appx.
28 Note that you don't need an existing signing key for Chrome, a new key 29 Note that you don't need an existing signing key for Chrome, a new key
29 will be created automatically if the file doesn't exist. 30 will be created automatically if the file doesn't exist.
30 31
31 ### Development environment 32 ### Development environment
32 33
33 To simplify the process of testing your changes you can create an unpacked 34 To simplify the process of testing your changes you can create an unpacked
34 development environment. For that run the following command: 35 development environment. For that run the following command:
kzar 2016/12/16 10:40:14 Same here, there are now multiple commands.
35 36
36 ./build.py -t chrome devenv 37 ./build.py -t chrome devenv
38 ./build.py -t edge devenv
37 39
38 This will create a _devenv.chrome_ directory in the repository. In Chrome you 40 This will create a _devenv.chrome_ directory in the repository. In Chrome you
kzar 2016/12/16 10:40:14 This is wrong now, since it will create either a _
39 should load the directory as an unpacked extension. After making changes to the 41 should load the directory as an unpacked extension. After making changes to the
40 source code re-run the command to update the development environment, the 42 source code re-run the command to update the development environment, the
41 extension should reload automatically after a few seconds. 43 extension should reload automatically after a few seconds.
42 44
45 For Edge you should load _devenv.edge/Extension_ as an unpacked extension direct ory. After
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.
kzar 2016/12/16 10:40:14 Please be a bit more specific here about when + ho
47
43 Running the unit tests 48 Running the unit tests
44 ---------------------- 49 ----------------------
45 50
46 To verify your changes you can use the unit test suite located in the _qunit_ 51 To verify your changes you can use the unit test suite located in the _qunit_
47 directory of the repository. In order to run the unit tests go to the 52 directory of the repository. In order to run the unit tests go to the
48 extension's Options page, open the JavaScript Console and type in: 53 extension's Options page, open the JavaScript Console and type in:
49 54
50 location.href = "qunit/index.html"; 55 location.href = "qunit/index.html";
51 56
52 The unit tests will run automatically once the page loads. 57 The unit tests will run automatically once the page loads.
OLDNEW
« no previous file with comments | « no previous file | icons/abp-150.png » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld