5b77381322df299ae298a035c9888967f8a1b105
[pub/Android/ownCloud.git] / SETUP.md
1
2 If you want to start development of ownCloud first download required files, then compile using console or Eclipse, finally create pull request:
3
4 1. Fork and download android/develop repository:
5
6 - NOTE: You must have git in your enviroment path
7 - Navigate to https://github.com/owncloud/android, click fork.
8 - Clone your new repo: "git clone git@github.com:YOURGITHUBNAME/android.git"
9 - "cd android"
10 - Checkout remote develop branch: "git checkout -b develop remotes/origin/develop"
11 - Make sure to get the latest changes of android/develop branch: "git pull origin develop"
12
13 2. Building with console/maven:
14
15 - OPTIONAL, CONTINUE WITH STEP 3 IF NOT REQUIRED!
16 - NOTE: You must have mvn in your enviroment path
17 - Download/install Android plugin for Maven, then build ownCloud with mvn:
18 - "cd .."
19 - "git clone https://github.com/mosabua/maven-android-sdk-deployer.git"
20 - "cd maven-android-sdk-deployer"
21 - "mvn -pl com.simpligility.android.sdk-deployer:android-17 -am install"
22 - "cd ../android"
23 - Now you can create APK using "mvn package"
24
25 3. Building with Eclipse:
26
27 - NOTE: You must have android/tools, and 'platforms-tools' in your enviroment path
28 - Prepare building with Eclipse:
29 - "setup_env.bat" or "./setup_env.sh"
30 - Open Eclipse and create new "Android Project from Existing Code". As root choose android/actionbarsherlock/library
31 - Increase Android API level until project compiles. 14 should work.
32 - Clean project and compile.
33 - Make sure android/actionbarsherlock/library/bin/library.jar was created!
34 - Import OwnCloud Android project.
35 - Increase Android API level to 17.
36 - Clean project and compile.
37 - After those actions you should be good to go. HAVE FUN!
38 - NOTE: Even though API level is set to 17, APK also runs on older devices because in AndroidManifest.xml minSdkVersion is set to 8.
39
40 4. Create pull request:
41
42 - Commit your changes locally: "git commit -a"
43 - Push your changes to your Github repo: "git push"
44 - Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
45 - Click "Edit" and set "base:develop"
46 - Again, click "Edit" and set "compare:develop"
47 - Enter description and send pull request.
48
49
50
51