diff --git a/SETUP.md b/SETUP.md index a965064413..39539038e9 100644 --- a/SETUP.md +++ b/SETUP.md @@ -1,10 +1,14 @@ -If you want to start help developing ownCloud please follow the [contribution guidelines][0] and observe these instructions: - -### 1. Fork and download android/develop repository: +If you want to start help developing ownCloud please follow the [contribution guidelines][0] and observe these instructions. -NOTE: You must have git in your environment path variable to perform the next operations. +If you have any problems, start again with 1) and work your way down. If something still does not work as described here, please open a new issue describing exactly what you did, what happened, and what should have happened. +### 1) Fork and download android/develop repository: + +NOTE: Android SDK with platforms 8, 14 and 19 (and maybe others) need to be installed. + You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable. + "git" need to be installed and in your environment path variable. + * Navigate to https://github.com/owncloud/android, click fork. * Clone your new repo: "git clone git@github.com:YOURGITHUBNAME/android.git" * Move to the project folder with "cd android" @@ -14,16 +18,16 @@ NOTE: You must have git in your environment path variable to perform the next op * Make sure to get the latest changes from official android/develop branch: "git pull upstream develop" * Complete the setup of project properties and resolve pending dependencies running "setup_env.bat" or "./setup_env.sh" . -At this point you can continue using different tools to build the project. Section 2, 3 and 4 describe some of the existing alternatives. +At this point you can continue using different tools to build the project. Sections 2a), 2b), and 2c) describe some of the existing alternatives. -### 2. Building with Ant: +### 2a) Building with Ant: NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable. * Run "ant clean" . * Run "ant debug" to generate a debuggable version of the ownCloud app. -### 3. Building with console/maven: +### 2b) Building with console/maven: NOTE: You must have mvn (version >= 3.1.1) in your environment path. Current Android 'platforms-tools' need to be installed. @@ -39,7 +43,7 @@ Download/install Android plugin for Maven, install owncloud-android-library, the Now you can create ownCloud APK using "mvn package" -### 4. Building with Eclipse: +### 2c) Building with Eclipse: NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable. @@ -47,11 +51,12 @@ NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in * Open Eclipse and create new "Android Project from Existing Code". Choose android/actionbarsherlock/library as root. * Clean project and compile. * If any error appear, check the project properties; in the 'Android' section, API Level should be greater or equal than 14. +* If "error loading libz.so.1" appears, try "sudo apt-get install lib32z1" * Make sure android/actionbarsherlock/library/bin/library.jar was created. -* Create a new "Android Project from Existing Code". Choose android/owncloud-android-library as root. +* Create a new "Android Project from Existing Code". Choose android/owncloud-android-library as root. (test and sample clients are not required.) * Clean project and compile. * If any error appear, check the project properties; in the 'Android' section, API Level should be 19 or greater. -* Make sure android/owncloud-android-library/bin/classes.jar was created. +* Make sure 'android/owncloud-android-library/bin/owncloud android library.jar' was created. * Import ownCloud Android project. * Clean project and compile. * If any error appears, check the project properties of owncloud-android project; in the 'Android' section: @@ -61,7 +66,7 @@ NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in NOTE: Even though API level is set to 19, APK also runs on older devices because in AndroidManifest.xml minSdkVersion is set to 8. -### 5. Create pull request: +### 3) Create pull request: NOTE: You must sign the [Contributor Agreement][1] before your changes can be accepted! @@ -72,7 +77,7 @@ NOTE: You must sign the [Contributor Agreement][1] before your changes can be ac * Again, click "Edit" and set "compare:develop" * Enter description and send pull request. -### 6. Create another pull request: +### 4) Create another pull request: 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. diff --git a/setup_env.sh b/setup_env.sh index e60475288c..ae4214238b 100755 --- a/setup_env.sh +++ b/setup_env.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/bin/bash -e git submodule init git submodule update