README.md - Issue 29345636: Issue 1414 - Document how to build libadblockplus for Android

Delta Between Two Patch Sets: README.md

Issue 29345636: Issue 1414 - Document how to build libadblockplus for Android (Closed)

Left Patch Set: With some Sergey's suggestions Created June 9, 2016, 11:36 a.m.

Right Patch Set: Created June 20, 2016, 3:27 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

LEFT	RIGHT
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	18 ### Supported target platforms and prerequisites

19	19

20 You need a C++11 compatible compiler to build libadblockplus.	20 You need a C++11 compatible compiler to build libadblockplus.

21	21

22 The compilation was tested with the following compilers:	22 Win32:

23 * g++ 4.8

24 * Microsoft Visual Studio 2010, 2012	23 * Microsoft Visual Studio 2010, 2012

25 * clang 3.4 for Android (from android-ndk-r9, android-ndk-r10c)	24

	25 Linux:

	26 * g++ 5.2

	27

	28 Mac:

26 * clang 3.6 for OS X	29 * clang 3.6 for OS X
sergei 2016/06/10 11:36:01 Could you please also add yet one line here? * To Could you please also add yet one line here? * To compile for Android on linux one need to install g++-multilib It's quite essential and can be tricky for a new person to find the proper packet. anton 2016/06/14 07:16:47 Acknowledged. Show quoted text On 2016/06/10 11:36:01, sergei wrote: > Could you please also add yet one line here? > > * To compile for Android on linux one need to install g++-multilib > > It's quite essential and can be tricky for a new person to find the proper > packet. Acknowledged.
27	30

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).	31 Android:
Wladimir Palant 2016/06/10 21:54:55 I think this is getting confusing as it sort of im I think this is getting confusing as it sort of implies that you need the Android SDK for Windows in order to build the Windows version of libadblockplus. This belongs into the "clang for Android" line above somehow. anton 2016/06/14 07:30:30 can you please explain what makes you think about Show quoted text On 2016/06/10 21:54:55, Wladimir Palant wrote: > I think this is getting confusing as it sort of implies that you need the > Android SDK for Windows in order to build the Windows version of libadblockplus. > This belongs into the "clang for Android" line above somehow. can you please explain what makes you think about SDK is required? The links are about NDK and the only reason for it is that we need pretty-old versions of NDK and they can't be found by the users on "Download NDK" google page. sergei 2016/06/14 08:05:29 Yeah, the links for windows were also confusing me Show quoted text On 2016/06/14 07:30:30, anton wrote: > On 2016/06/10 21:54:55, Wladimir Palant wrote: > > I think this is getting confusing as it sort of implies that you need the > > Android SDK for Windows in order to build the Windows version of > libadblockplus. > > This belongs into the "clang for Android" line above somehow. > > can you please explain what makes you think about SDK is required? The links are > about NDK and the only reason for it is that we need pretty-old versions of NDK > and they can't be found by the users on "Download NDK" google page. Yeah, the links for windows were also confusing me, I think this section should be restructured, like Target platform: - addition information. Something like the following: Win32: - Microsoft Visual Studio 2010, 2012 Linux: - g++ 5.2 Mac: clang 3.6 for OS X Android: - the host system should be linux or OS X (BTW, it seems there is some issue with recent updates on OS X) - version of Android NDK - links to Android NDK for linx and OS X (without links for Windows because nobody tried it yet). - g++ multilib. anton 2016/06/14 08:07:29 Acknowledged. Show quoted text On 2016/06/14 08:05:29, sergei wrote: > On 2016/06/14 07:30:30, anton wrote: > > On 2016/06/10 21:54:55, Wladimir Palant wrote: > > > I think this is getting confusing as it sort of implies that you need the > > > Android SDK for Windows in order to build the Windows version of > > libadblockplus. > > > This belongs into the "clang for Android" line above somehow. > > > > can you please explain what makes you think about SDK is required? The links > are > > about NDK and the only reason for it is that we need pretty-old versions of > NDK > > and they can't be found by the users on "Download NDK" google page. > > Yeah, the links for windows were also confusing me, I think this section should > be restructured, like > Target platform: > - addition information. > > Something like the following: > > Win32: > - Microsoft Visual Studio 2010, 2012 > Linux: > - g++ 5.2 > Mac: > clang 3.6 for OS X > Android: > - the host system should be linux or OS X (BTW, it seems there is some issue > with recent updates on OS X) > - version of Android NDK > - links to Android NDK for linx and OS X (without links for Windows because > nobody tried it yet). > - g++ multilib. Acknowledged.
29	32 * The host system should be Linux or OS X

30 If you have a question about another compiler please [create an issue](https://i ssues.adblockplus.org/).	33 * android-ndk-r9, android-ndk-r10c. You can download the latter for [OS X](http: //dl.google.com/android/ndk/android-ndk-r10c-darwin-x86_64.bin), [Linux 32](http ://dl.google.com/android/ndk/android-ndk-r10c-linux-x86.bin), [Linux 64](http:// dl.google.com/android/ndk/android-ndk-r10c-linux-x86_64.bin).
Wladimir Palant 2016/06/10 21:54:55 While you didn't add this sentence: Are we serious While you didn't add this sentence: Are we seriously suggesting creating issues for questions? Maybe only create an issue if people try another compile and hit issues? anton 2016/06/14 07:16:47 i've just left this sentence as it was and i agree Show quoted text On 2016/06/10 21:54:55, Wladimir Palant wrote: > While you didn't add this sentence: Are we seriously suggesting creating issues > for questions? Maybe only create an issue if people try another compile and hit > issues? i've just left this sentence as it was and i agree we should get issues if the user have a problem instead of just a question. Sergei, are you agree to change this to "If you have a compilation problem with another compiler .." ? sergei 2016/06/14 08:05:29 Yes, I agree. Just in case, I would like to preci Show quoted text On 2016/06/14 07:16:47, anton wrote: > On 2016/06/10 21:54:55, Wladimir Palant wrote: > > While you didn't add this sentence: Are we seriously suggesting creating > issues > > for questions? Maybe only create an issue if people try another compile and > hit > > issues? > > i've just left this sentence as it was and i agree we should get issues if the > user have a problem instead of just a question. Sergei, are you agree to change > this to "If you have a compilation problem with another compiler .." ? Yes, I agree. Just in case, I would like to precise that the current form is fine for me but generally speaking we cannot support all other compilers (e.g. for MIPS). However I would like to have such sentence in the readme file, because we can always try to help with an advice or may be there is indeed a bug in our configuration, which is not visible on our machines, as well as it's useful to see who and what the interest has in this project.
	34 * g++ multilib

	35

	36 If you have a compilation issue with another compiler please [create an issue](h ttps://issues.adblockplus.org/).

31	37

32 ### Unix	38 ### Unix

33	39

34 All you need is Python 2.7 and Make:	40 All you need is Python 2.7 and Make:

35	41

36 make	42 make

37	43

38 The default target architecture is x64. On a 32 bit system, run:	44 The default target architecture is x64. On a 32 bit system, run:

39	45

40 make ARCH=ia32	46 make ARCH=ia32

(...skipping 182 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
223	229

224 ### Unix	230 ### Unix

225	231

226 The shell is automatically built by `make`, you can run it as follows:	232 The shell is automatically built by `make`, you can run it as follows:

227	233

228 build/out/abpshell	234 build/out/abpshell

229	235

230 ### Windows	236 ### Windows

231	237

232 Just run the project abpshell.	238 Just run the project abpshell.

LEFT	RIGHT