README.md - Issue 5133042217648128: Add a README with build instructions

Delta Between Two Patch Sets: README.md

Issue 5133042217648128: Add a README with build instructions (Closed)

Left Patch Set: Created March 5, 2014, 2:27 p.m.

Right Patch Set: Fixed Ant build instructions, added instructions for running Created March 5, 2014, 2:45 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 Adblock Plus for Android	1 Adblock Plus for Android

2 ========================	2 ========================

3	3

4 An Android app that runs a proxy to block ads.	4 An Android app that runs a proxy to block ads.

5	5

6 Buildling with Ant	6 Buildling with Ant

7 ------------------	7 ------------------

8	8

9 ### Requirements	9 ### Requirements

10	10

11 - [The Android SDK](http://developer.android.com/sdk)	11 - [The Android SDK](http://developer.android.com/sdk)

12 - [The Android NDK](https://developer.android.com/tools/sdk/ndk)	12 - [The Android NDK](https://developer.android.com/tools/sdk/ndk)

13 - [Ant](http://ant.apache.org)	13 - [Ant](http://ant.apache.org)
Wladimir Palant 2014/03/05 14:45:09 Does the JDK count as a requirement? Does the JDK count as a requirement? Felix Dahlke 2014/03/05 14:47:57 It's part of the Android SDK requirements, should Show quoted text On 2014/03/05 14:45:09, Wladimir Palant wrote: > Does the JDK count as a requirement? It's part of the Android SDK requirements, should suffice IMO.
14	14

15 ### Building	15 ### Building

16	16

17 In the project directory, create the file _local.properties_ and set	17 In the project directory, create the file _local.properties_ and set

18 _sdk.dir_ and _ndk.dir_ to where you installed it, e.g.:	18 _sdk.dir_ and _ndk.dir_ to where you installed it, e.g.:

19	19

20 sdk.dir = /some/where/sdk	20 sdk.dir = /some/where/sdk

21 ndk.dir = /some/where/ndk	21 ndk.dir = /some/where/ndk

22	22

23 Then run:	23 Then run:

24	24

25 ant build	25 ant debug
René Jeschke 2014/03/05 14:38:22 There is no 'build' target in the build.xml file. There is no 'build' target in the build.xml file. A list of targets is available using 'ant help'. Wladimir Palant 2014/03/05 14:45:09 Right, it is either ant debug or ant release. Show quoted text On 2014/03/05 14:38:22, rene wrote: > There is no 'build' target in the build.xml file. Right, it is either ant debug or ant release. Felix Dahlke 2014/03/05 14:47:57 Done. Oops :) Show quoted text On 2014/03/05 14:45:09, Wladimir Palant wrote: > On 2014/03/05 14:38:22, rene wrote: > > There is no 'build' target in the build.xml file. > > Right, it is either ant debug or ant release. > Done. Oops :)
	26

	27 ### Running

	28

	29 Connect an Android device or start the Android Emulator, then run:

	30

	31 ant debug install

	32

	33 Finally, you can run _Adblock Plus_ from the launcher.

26	34

27 Building with Eclipse	35 Building with Eclipse

28 ---------------------	36 ---------------------

29	37

30 ### Requirements	38 ### Requirements

31	39

32 - [The Android SDK](http://developer.android.com/sdk)	40 - [The Android SDK](http://developer.android.com/sdk)

33 - [The Android NDK](https://developer.android.com/tools/sdk/ndk)	41 - [The Android NDK](https://developer.android.com/tools/sdk/ndk)

34 - [Eclipse](https://www.eclipse.org)	42 - [Eclipse](https://www.eclipse.org)

35 - [Android Developer Tools for Eclipse](http://developer.android.com/tools/sdk/e clipse-adt.html)	43 - [Android Developer Tools for Eclipse](http://developer.android.com/tools/sdk/e clipse-adt.html)

36 (both _Developer Tools_ and _NDK Plugins_)	44 (both _Developer Tools_ and _NDK Plugins_)

37 - [C++ Developer Tools for Eclipse](http://projects.eclipse.org/projects/tools.c dt)	45 - [C++ Developer Tools for Eclipse](http://projects.eclipse.org/projects/tools.c dt)

38	46

39 ### Building	47 ### Building

40	48

41 1. Select _Import_ in the _File_ menu, then _Existing Android Projects Into Work space_.	49 1. Select _Import_ in the _File_ menu, then _Existing Android Projects Into Work space_.

42 2. Select the project directory (_adblockplusandroid_) as _Root Directory_.	50 2. Select the project directory (_adblockplusandroid_) as _Root Directory_.

43 3. Select the projects _Adblock Plus_, _library_ and _android-switch-backport_.	51 3. Select the projects _Adblock Plus_, _library_ and _android-switch-backport_.

44 4. Revert any local changes to _.classpath_ in _adblockplusandroid_	52 4. Revert any local changes to _.classpath_ in _adblockplusandroid_

45 and _adblockplusandroid/submodules/android-switch-backport_.	53 and _adblockplusandroid/submodules/android-switch-backport_.

	54

	55 ### Running

	56

	57 1. Connect an Android device or start the Android Emulator.

	58 2. In Eclipse, select the _Adblock Plus_ project, then run it as an

	59 _Android Application_.

LEFT	RIGHT