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

Delta Between Two Patch Sets: README.md

Issue 29324576: Issue 2599, 2940 - Fix the presence of correct ATL version (Closed)
Left Patch Set: add tested environments Created Aug. 26, 2015, 9:44 p.m.
Right Patch Set: address comment, precise python version Created Dec. 2, 2015, 9:11 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « no previous file | adblockplus.gyp » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
1 Adblock Plus for Internet Explorer 1 Adblock Plus for Internet Explorer
2 ================================== 2 ==================================
3 3
4 This combines a Browser Helper Object with a singleton engine process to block 4 This combines a Browser Helper Object with a singleton engine process to block
5 ads in Internet Explorer. The engine process embeds libadblockplus. 5 ads in Internet Explorer. The engine process embeds libadblockplus.
6
7 Requirements to work with the repository and the code
8 -----------------------------------------------------
9
10 ### Python
11 You need to have installed python 2.7. It should be the version available by
12 default from Visual Studio as well as in your command line environment.
13 Simply put, make sure that path to `python.exe` is in your `PATH` environment
14 variable.
15
16 ### Visual C++ toolset
17 There should be available v110 and v110_xp toolsets. For instance, they are
18 contained in freely available Visual Studio 2012 Express for Windows Desktop
19 and in any paid edition of Visual Studio 2012. Take into account that you might
20 need to get the recent updates of mentioned editions, more details about
21 v110_xp https://msdn.microsoft.com/en-us/library/jj851139.aspx.
22
23 ### ATL versions
24 It works with ATL shipped with any paid edition of Visual Studio 2012 as well
25 as with ATL shipped with Visual Studio 2013 Community edition.
26 If you use Visual Studio 2013 Community Edition as the source of ATL then set
27 `ADBLOCKPLUS_ATL` environment variable to the directory of the corresponding
28 ATL (e.g, `C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\atlmfc`)
29 Attention:
30 - ATL is not shipped with Express edition of any Visual Studio.
31 - ATL from Visual Studio 2015 is not supported.
32 More information about libraies and headers in Visual Studios:
33 2015 - https://msdn.microsoft.com/en-us/library/hs24szh9(v=vs.140).aspx
34 2013 - https://msdn.microsoft.com/en-us/library/hs24szh9(v=vs.120).aspx
35 2012 - https://msdn.microsoft.com/en-us/library/hs24szh9(v=vs.110).aspx
36
37 ### Visual Studio as an IDE
38 Currently the project configured to work with MS Visual Studio 2012 as an IDE
39 because the main development and release builds are in Visual Studio 2012.
40 However one can also use any higher version of Visual Studio as and IDE, the
41 caveat is to disable "Upgrade C++ Compilers and Libraries".
6 42
7 Getting/updating the dependencies 43 Getting/updating the dependencies
8 --------------------------------- 44 ---------------------------------
9 45
10 adblockplusie has dependencies that aren't part of this repository. They are 46 adblockplusie has dependencies that aren't part of this repository. They are
11 retrieved and updated when you're generating the VS solution for the build, but 47 retrieved and updated when you're generating the VS solution for the build, but
12 you can also manually update them by running the following: 48 you can also manually update them by running the following:
13 49
14 ./ensure_dependencies.py 50 ./ensure_dependencies.py
15 51
16 Building 52 Building
17 -------- 53 --------
18 54
19 You need Microsoft Visual C++ 2012 and Python 2.7. Make sure that `python.exe`
Eric 2015/10/08 14:36:35 This line of text has become confusing given the f
20 is on your `PATH`. When building with Express edition you also need some
21 Visual Studio which comes with ATL. For example, if you use Visual Studio 2013
22 Community Edition then set `VCInstallDir_120` environment variable to the
23 directory of Visual C++ (for example,
24 `C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC`).
25
26 Building is tested on the following configurations 55 Building is tested on the following configurations
27 - [free for everybody] "Microsoft Visual Studio Express 2012 for Windows 56 - [free for everybody] "Microsoft Visual Studio Express 2012 for Windows
28 Desktop" with "Microsoft Visual Studio Community 2013" as the source of ATL. 57 Desktop" as the source of toolset with "Microsoft Visual Studio Community 2013"
29 - "Microsoft Visual Studio Express 2012 for Windows Desktop" with "Microsoft 58 as the source of ATL. Pay attention to the configuring of the environment
30 Visual Studio Professional 2012" as the source of ATL. 59 described in "ATL versions" section.
31 - "Microsoft Visual Studio Professional 2012" 60 - "Microsoft Visual Studio Professional 2012"
32 - "Microsoft Visual Studio Ultimate 2012" 61 - "Microsoft Visual Studio Ultimate 2012"
33 62
34 * Execute `createsolution.bat` to retrieve dependencies and generate project 63 * Execute `createsolution.bat` to retrieve dependencies and generate project
35 files, this will create `build\ia32\adblockplus.sln` (solution for the 32 bit 64 files, this will create `build\ia32\adblockplus.sln` (solution for the 32 bit
36 build) and `build\x64\adblockplus.sln` (solution for the 64 bit build). 65 build) and `build\x64\adblockplus.sln` (solution for the 64 bit build).
37 Unfortunately, V8 (which is used by libadblockplus) doesn't support creating 66 Unfortunately, V8 (which is used by libadblockplus) doesn't support creating
38 both from the same project files. 67 both from the same project files.
Eric 2015/10/08 14:36:35 I would add a separate paragraph about the environ
39 * Open `build\ia32\adblockplus.sln` or `build\x64\adblockplus.sln` in 68 * Open `build\ia32\adblockplus.sln` or `build\x64\adblockplus.sln` in
40 Visual Studio and build the solution there. Alternatively you can use the 69 Visual Studio and build the solution there. Alternatively you can use the
41 `msbuild` command line tool, e.g. run `msbuild /m build\ia32\adblockplus.sln` 70 `msbuild` command line tool, e.g. run `msbuild /m build\ia32\adblockplus.sln`
42 from the Visual Studio Developer Command Prompt to create a 32 bit debug build. 71 from the Visual Studio Developer Command Prompt to create a 32 bit debug build.
43 72
44 Running 73 Running
45 ------- 74 -------
46 75
47 In order to test the extension, you need to register the Browser 76 In order to test the extension, you need to register the Browser
48 Helper Object with IE. You can do this by locating _AdblockPlus.dll_ 77 Helper Object with IE. You can do this by locating _AdblockPlus.dll_
(...skipping 14 matching lines...) Expand all
63 files, this will create a bunch of project files in the _installer\build\ia32_ 92 files, this will create a bunch of project files in the _installer\build\ia32_
64 and _installer\build\x64_ directories. 93 and _installer\build\x64_ directories.
65 * Open and build `installer\build\ia32\installer.sln` and 94 * Open and build `installer\build\ia32\installer.sln` and
66 `installer\build\x64\installer.sln` in Visual Studio. Alternatively you can use 95 `installer\build\x64\installer.sln` in Visual Studio. Alternatively you can use
67 the `msbuild` command line tool, i.e. run 96 the `msbuild` command line tool, i.e. run
68 `msibuild /m installer\build\ia32\adblockplus.sln` and 97 `msibuild /m installer\build\ia32\adblockplus.sln` and
69 `msibuild /m installer\build\x64\adblockplus.sln` from the Visual Studio 98 `msibuild /m installer\build\x64\adblockplus.sln` from the Visual Studio
70 Developer Command Prompt. 99 Developer Command Prompt.
71 * Either open and compile `installer\src\innosetup-exe\64BitTwoArch.iss` in 100 * Either open and compile `installer\src\innosetup-exe\64BitTwoArch.iss` in
72 InnoSetup or run `iscc.exe installer\src\innosetup-exe\64bitTwoArch.iss`. 101 InnoSetup or run `iscc.exe installer\src\innosetup-exe\64bitTwoArch.iss`.
LEFTRIGHT
« no previous file | adblockplus.gyp » ('j') | Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Toggle Comments ('s')

Powered by Google App Engine
This is Rietveld