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

Side by Side Diff: README.md

Issue 29345636: Issue 1414 - Document how to build libadblockplus for Android (Closed)
Patch Set: With some Sergey's suggestions Created June 9, 2016, 11:36 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 | 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
1 libadblockplus 1 libadblockplus
2 ============== 2 ==============
3 3
4 A C++ library offering the core functionality of Adblock Plus. 4 A C++ library offering the core functionality of Adblock Plus.
5 5
6 Getting/updating the dependencies 6 Getting/updating the dependencies
7 --------------------------------- 7 ---------------------------------
8 8
9 libadblockplus has dependencies that aren't part of this repository. They are 9 libadblockplus has dependencies that aren't part of this repository. They are
10 retrieved and updated during the build process, but you can also manually update 10 retrieved and updated during the build process, but you can also manually update
11 them by running the following: 11 them by running the following:
12 12
13 ./ensure_dependencies.py 13 ./ensure_dependencies.py
14 14
15 Building 15 Building
16 -------- 16 --------
17 17
18 ### Supported compilers
19
20 You need a C++11 compatible compiler to build libadblockplus.
21
22 The compilation was tested with the following compilers:
23 * g++ 4.8
24 * Microsoft Visual Studio 2010, 2012
25 * clang 3.4 for Android (from android-ndk-r9, android-ndk-r10c)
26 * clang 3.6 for OS X
sergei 2016/06/10 11:36:01 Could you please also add yet one line here? * To
anton 2016/06/14 07:16:47 Acknowledged.
27
28 You can download *android-ndk-r10c* for [Win 32](http://dl.google.com/android/nd k/android-ndk-r10c-windows-x86.exe), [Win 64](http://dl.google.com/android/ndk/a ndroid-ndk-r10c-windows-x86_64.exe), [OSX](http://dl.google.com/android/ndk/andr oid-ndk-r10c-darwin-x86_64.bin), [Linux 32](http://dl.google.com/android/ndk/and roid-ndk-r10c-linux-x86.bin), [Linux 64](http://dl.google.com/android/ndk/androi d-ndk-r10c-linux-x86_64.bin).
Wladimir Palant 2016/06/10 21:54:55 I think this is getting confusing as it sort of im
anton 2016/06/14 07:30:30 can you please explain what makes you think about
sergei 2016/06/14 08:05:29 Yeah, the links for windows were also confusing me
anton 2016/06/14 08:07:29 Acknowledged.
29
30 If you have a question about another compiler please [create an issue](https://i ssues.adblockplus.org/).
Wladimir Palant 2016/06/10 21:54:55 While you didn't add this sentence: Are we serious
anton 2016/06/14 07:16:47 i've just left this sentence as it was and i agree
sergei 2016/06/14 08:05:29 Yes, I agree. Just in case, I would like to preci
31
18 ### Unix 32 ### Unix
19 33
20 All you need is Python 2.7 and Make: 34 All you need is Python 2.7 and Make:
21 35
22 make 36 make
23 37
24 The default target architecture is x64. On a 32 bit system, run: 38 The default target architecture is x64. On a 32 bit system, run:
25 39
26 make ARCH=ia32 40 make ARCH=ia32
27 41
(...skipping 16 matching lines...) Expand all
44 58
45 * Execute `createsolution.bat` to generate project files, this will create 59 * Execute `createsolution.bat` to generate project files, this will create
46 `build\ia32\libadblockplus.sln` (solution for the 32 bit build) and 60 `build\ia32\libadblockplus.sln` (solution for the 32 bit build) and
47 `build\x64\libadblockplus.sln` (solution for the 64 bit build). Unfortunately, 61 `build\x64\libadblockplus.sln` (solution for the 64 bit build). Unfortunately,
48 V8 doesn't support creating both from the same project files. 62 V8 doesn't support creating both from the same project files.
49 * Open `build\ia32\libadblockplus.sln` or `build\x64\libadblockplus.sln` in 63 * Open `build\ia32\libadblockplus.sln` or `build\x64\libadblockplus.sln` in
50 Visual Studio and build the solution there. Alternatively you can use the 64 Visual Studio and build the solution there. Alternatively you can use the
51 `msbuild` command line tool, e.g. run `msbuild /m build\ia32\libadblockplus.sln` 65 `msbuild` command line tool, e.g. run `msbuild /m build\ia32\libadblockplus.sln`
52 from the Visual Studio Developer Command Prompt to create a 32 bit debug build. 66 from the Visual Studio Developer Command Prompt to create a 32 bit debug build.
53 67
54 ### Supported compilers 68 ### Building for Android
55 69
56 You need a C++11 compatible compiler to build libadblockplus. 70 First set ANDROID_NDK_ROOT environment variable to your Android NDK directory.
57 71
58 The compilation was tested with the following compilers: 72 To build for *x86* arch run:
59 * g++ 4.8
60 * Microsoft Visual Studio 2010, 2012
61 * clang 3.4 for Android (from android-ndk-r9)
62 * clang 3.6 for OS X
63 73
64 If you have a question about another compiler please [create an issue](https://i ssues.adblockplus.org/). 74 make android_x86
75
76 To build for *arm* arch run:
77
78 make android_arm
65 79
66 Usage 80 Usage
67 ----- 81 -----
68 82
69 You can use libadblockplus to build an ad blocker. Or, strictly speaking, a web 83 You can use libadblockplus to build an ad blocker. Or, strictly speaking, a web
70 content filter. Just like Adblock Plus, it can detect resources that should be 84 content filter. Just like Adblock Plus, it can detect resources that should be
71 blocked based on their URL and context information, and generate CSS selectors 85 blocked based on their URL and context information, and generate CSS selectors
72 to hide DOM elements. 86 to hide DOM elements.
73 87
74 The basic usage is explained below, see the 88 The basic usage is explained below, see the
(...skipping 134 matching lines...) Expand 10 before | Expand all | Expand 10 after
209 223
210 ### Unix 224 ### Unix
211 225
212 The shell is automatically built by `make`, you can run it as follows: 226 The shell is automatically built by `make`, you can run it as follows:
213 227
214 build/out/abpshell 228 build/out/abpshell
215 229
216 ### Windows 230 ### Windows
217 231
218 Just run the project *abpshell*. 232 Just run the project *abpshell*.
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