SETUP.md

   1
   2   If you want to start help developing ownCloud please follow the [contribution guidlines][0] and observe these instructions:
   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   -  Pull changes from your develop branch: "git pull origin develop"
  12   -  Make sure to get the latest changes from official android/develop branch:
  13   -  Make official owncloud repo known as upstream: "git remote add upstream git@github.com:owncloud/android.git"
  14   -  Pull latest changes from upstream: "git pull upstream develop"
  15
  16   2. Building with console/maven:
  17
  18   -  OPTIONAL, CONTINUE WITH STEP 3 IF NOT REQUIRED!
  19   -  NOTE: You must have mvn in your enviroment path
  20   -  Download/install Android plugin for Maven, then build ownCloud with mvn:
  21   -  "cd .."
  22   -  "git clone https://github.com/mosabua/maven-android-sdk-deployer.git"
  23   -  "cd maven-android-sdk-deployer"
  24   -  "mvn -pl com.simpligility.android.sdk-deployer:android-17 -am install"
  25   -  "cd ../android"
  26   -  Now you can create APK using "mvn package"
  27
  28   3. Building with Eclipse:
  29
  30   -  NOTE: You must have android/tools, and 'platforms-tools' in your enviroment path
  31   -  Prepare building with Eclipse:
  32   -  "setup_env.bat" or "./setup_env.sh"
  33   -  Open Eclipse and create new "Android Project from Existing Code". As root choose android/actionbarsherlock/library
  34   -  Increase Android API level until project compiles. 14 should work.
  35   -  Clean project and compile.
  36   -  Make sure android/actionbarsherlock/library/bin/library.jar was created!
  37   -  Import OwnCloud Android project.
  38   -  Increase Android API level to 17.
  39   -  Clean project and compile.
  40   -  After those actions you should be good to go. HAVE FUN!
  41   -  NOTE: Even though API level is set to 17, APK also runs on older devices because in AndroidManifest.xml minSdkVersion is set to 8.
  42
  43   4. Create pull request:
  44
  45   -  NOTE: You must sign the [Contributor Agreement][1] before your changes can be accepted!
  46   -  Commit your changes locally: "git commit -a"
  47   -  Push your changes to your Github repo: "git push"
  48   -  Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
  49   -  Click "Edit" and set "base:develop"
  50   -  Again, click "Edit" and set "compare:develop"
  51   -  Enter description and send pull request.
  52
  53
  54 [0]: https://github.com/owncloud/android/blob/master/CONTRIBUTING.md
  55 [1]: http://owncloud.org/about/contributor-agreement/
  56