SETUP.md

   1
   2 If you want to start help developing ownCloud please follow the [contribution guidelines][0] and observe these instructions:
   3
   4 ### 1. Fork and download android/develop repository:
   5
   6 NOTE: You must have git in your environment path variable to perform the next operations.
   7
   8 * Navigate to https://github.com/owncloud/android, click fork.
   9 * Clone your new repo: "git clone git@github.com:YOURGITHUBNAME/android.git"
  10 * Move to the project folder with "cd android"
  11 * Checkout remote develop branch: "git checkout -b develop remotes/origin/develop"
  12 * Pull changes from your develop branch: "git pull origin develop"
  13 * Make official ownCloud repo known as upstream: "git remote add upstream git@github.com:owncloud/android.git"
  14 * Make sure to get the latest changes from official android/develop branch: "git pull upstream develop"
  15 * Complete the setup of project properties and resolve pending dependencies running "setup_env.bat" or "./setup_env.sh" .
  16
  17 At this point you can continue using different tools to build the project. Section 2, 3 and 4 describe some of the existing alternatives.
  18
  19 ### 2. Building with Ant:
  20
  21 NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable.
  22
  23 * Run "ant clean" .
  24 * Run "ant debug" to generate a debuggable version of the ownCloud app.
  25
  26 ### 3. Building with console/maven:
  27
  28 NOTE: You must have mvn (version >= 3.1.1) in your environment path. Current Android 'platforms-tools' need to be installed.
  29
  30 Download/install Android plugin for Maven, install owncloud-android-library, then build ownCloud with mvn:
  31
  32 * cd ..
  33 * git clone https://github.com/mosabua/maven-android-sdk-deployer.git
  34 * cd maven-android-sdk-deployer
  35 * mvn -pl com.simpligility.android.sdk-deployer:android-19 -am install
  36 * cd ../android/owncloud-android-library
  37 * mvn install
  38 * cd ..
  39
  40 Now you can create ownCloud APK using "mvn package"
  41
  42 ### 4. Building with Eclipse:
  43
  44 NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable.
  45
  46 * Complete the setup of project properties and resolve pending dependencies running "setup_env.bat" or "./setup_env.sh" .
  47 * Open Eclipse and create new "Android Project from Existing Code". Choose android/actionbarsherlock/library as root.
  48 * Clean project and compile.
  49 * If any error appear, check the project properties; in the 'Android' section, API Level should be greater or equal than 14.
  50 * Make sure android/actionbarsherlock/library/bin/library.jar was created.
  51 * Create a new "Android Project from Existing Code". Choose android/owncloud-android-library as root.
  52 * Clean project and compile.
  53 * If any error appear, check the project properties; in the 'Android' section, API Level should be 19 or greater.
  54 * Make sure android/owncloud-android-library/bin/classes.jar was created.
  55 * Import ownCloud Android project.
  56 * Clean project and compile.
  57 * If any error appears, check the project properties of owncloud-android project; in the 'Android' section:
  58   - API Level should be 19 or greater.
  59   - Two library projects should appear referred in the bottom square: actionbarsherlock/library and owncloud-android-library. Add them if needed.
  60 * After those actions you should be good to go. HAVE FUN!
  61
  62 NOTE: Even though API level is set to 19, APK also runs on older devices because in AndroidManifest.xml minSdkVersion is set to 8.
  63
  64 ### 5. Create pull request:
  65
  66 NOTE: You must sign the [Contributor Agreement][1] before your changes can be accepted!
  67
  68 * Commit your changes locally: "git commit -a"
  69 * Push your changes to your Github repo: "git push"
  70 * Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
  71 * Click "Edit" and set "base:develop"
  72 * Again, click "Edit" and set "compare:develop"
  73 * Enter description and send pull request.
  74
  75 ### 6. Create another pull request:
  76
  77 To make sure your new pull request does not contain commits which are already contained in previous PRs, create a new branch which is a clone of upstream/develop.
  78
  79 * git fetch upstream
  80 * git checkout -b my_new_develop_branch upstream/develop
  81 * If you want to rename that branch later: "git checkout -b my_new_develop_branch_with_new_name"
  82 * Push branch to server: "git push -u origin name_of_local_develop_branch"
  83 * Use Github to issue PR
  84
  85
  86 [0]: https://github.com/owncloud/android/blob/master/CONTRIBUTING.md
  87 [1]: http://owncloud.org/about/contributor-agreement/