[tx-robot] updated from transifex

[pub/Android/ownCloud.git] / SETUP.md

diff --git a/SETUP.md b/SETUP.md
index 3392db2..0f1bc8e 100644 (file)
--- a/SETUP.md
+++ b/SETUP.md
@@ -1,116 +1,160 @@
 
 

-If you want to start help developing ownCloud please follow the [contribution guidelines][0] and observe these instructions:
+These instructions will help you to set up your development environment, get the source code of the ownCloud for Android app and build it by yourself. If you want to help developing the app take a look to the [contribution guidelines][0].

 
 

-### 1. Fork and download android/develop repository:
+Sections 1) and 2) are common for any environment. The rest of the sections describe how to set up a project in different tool environments. Choose the build tool or IDE you prefer and follow the instructions in its specific section. Nowadays we recommend to use Android Studio (section 2), but the decision is up to you.

 
 

-NOTE: You must have git in your environment path variable to perform the next operations.
+If you have any problem, remove the 'android' folder, start again from 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.

 
 

-* 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"
-* Checkout remote develop branch: "git checkout -b develop remotes/origin/develop"
-* Pull changes from your develop branch: "git pull origin develop"
-* Make official ownCloud repo known as upstream: "git remote add upstream git@github.com:owncloud/android.git"
-* Make sure to get the latest changes from official android/develop branch: "git pull upstream develop"

 
 

-At this point you can continue using different tools to build the project. Section 2, 3, 4, 5 and 6 describe some of the existing alternatives.
+### 0. Common software dependencies.

 
 

-### 2. Building with Ant:
+There are some tools needed, no matter what is your specific IDE or build tool of preference.

 
 

-NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable.
+[git][1] is used to access to the different versions of the ownCloud's source code. Download and install the version appropiate for your operating system from [here][2]. Add the full path to the 'bin/' directory from your git installation into the PATH variable of your environment so that it can be used from any location.

 
 

-* Resolve necessary dependencies running:
-    - Windows: "setup_env.bat ant"
-    - Mac OS/Linux: "./setup_env.sh ant"
-* Run "ant clean".
-* Run "ant debug" to generate a debuggable version of the ownCloud app.
+The [Android SDK][3] is necessary to build the app. There are different options to install it in your system, depending of the IDE you decide to use. Check Google documentation about [installation][4] for more details on these options. After installing it, add the full path to the directories 'tools/' and 'platform-tools/' from your Android SDK installation into the PATH variable of your environment.

 
 

-### 3. Building with console/maven:
+Open a terminal and type 'android' to start the Android SDK Manager. To build the ownCloud for Android app you will need to install at least the next SDK packages:

 
 

-NOTE: You must have mvn (version >= 3.1.1) in your environment path. Current Android 'platforms-tools' need to be installed.
+* Android SDK Tools and Android SDK Platform-tools (already installed); upgrade to their last versions is usually a good idea.
+* Android SDK Build-Tools; any version from 20 or later should work fine; avoid preview versions, if any available.
+* Android 4.4.2 (API 19), SDK Platform; needed for build/test ownCloud app.
+* Android 5.1.1 (API 22), SDK Platform; needed to build the Android Support Library (not neeeded if working with Android Studio or gradle) and build the owncloud app.

 
 

-Download/install Android plugin for Maven, then build ownCloud with mvn:
+Install any other package you consider interesting, such as emulators.

 
 

-* Resolve necessary dependencies running:
-    - Windows: "setup_env.bat maven"
-    - Mac OS/Linux: "./setup_env.sh maven"
-* cd ..
-* git clone https://github.com/mosabua/maven-android-sdk-deployer.git
-* cd maven-android-sdk-deployer
-* mvn -pl com.simpligility.android.sdk-deployer:android-19 -am install
-* cd ../android/owncloud-android-library
-* mvn install
-* cd ..
+For other software dependencies check the details in the section corresponding to your preferred IDE or build system.

 
 

-Now you can create ownCloud APK using "mvn package" and find it as ownCloud.apk under the target

 
 

-### 4. Building with Gradle:
+### 1. Fork and download the owncloud/android repository.
+
+You will need [git][1] to access to the different versions of the ownCloud's source code. The source code is hosted in Github and may be read by anybody without needing a Github account. You will need a Github account if you want to contribute to the development of the app with your own code.
+
+Next steps will assume you have a Github account and that you will get the code from your own fork. 
+
+* In a web browser, go to https://github.com/owncloud/android, and click the 'Fork' button near the top right corner.
+* Open a terminal and go on with the next steps in it.
+* Clone your forked repository: ```git clone git@github.com:YOURGITHUBNAME/android.git```.
+* Move to the project folder with ```cd android```.
+* Checkout the remote branch 'master' in your own local branch 'master': ```git checkout master remotes/origin/master```.
+* Pull any changes from your remote branch 'master': ```git pull origin master```
+* Make official ownCloud repo known as upstream: ```git remote add upstream git@github.com:owncloud/android.git```
+* Make sure to get the latest changes from official android/master branch: ```git pull upstream master```
+
+At this point you can continue using different tools to build the project. Section 2, 3, 4, 5 and 6 describe the existing alternatives.
+
+
+### 2. Working with Android Studio.
+
+[Android Studio][5] is currently the official Android IDE. Due to this, we recommend it as the IDE to use in your development environment. Follow the installation instructions [here][6].
+
+We recommend to use the last version available in the stable channel of Android Studio updates. See what update channel is your Android Studio checking for updates in the menu path 'Help'/'Check for Update...'/link 'Updates' in the dialog.
+
+To set up the project in Android Studio follow the next steps:

 
 * Complete the setup of project properties running:
 
 * Complete the setup of project properties running:

-    - Windows: "setup_env.bat gradle"
-    - Mac OS/Linux: "./setup_env.sh gradle"
-* Open a terminal and go to the "android" directory that contains the repository.
-* Run the 'clean' and 'build' tasks using the Gradle wrapper provided:
-    - Windows: gradlew.bat clean build
-    - Mac OS/Linux: ./gradlew clean build
-* You can find the generated apk file in android/build/outputs/apk
+    - Windows: ```setup_env.bat gradle```
+    - Mac OS/Linux: ```./setup_env.sh gradle```
+* Open Android Studio and select 'Import Project (Eclipse ADT, Gradle, etc)'. Browse through your file system to the folder 'android' where the project is located. Android Studio will then create the '.iml' files it needs. If you ever close the project but the files are still there, you just select 'Open Project...'. The file chooser will show an Android face as the folder icon, which you can select to reopen the project.
+* Android Studio will try to build the project directly after importing it. To build it manually, follow the menu path 'Build'/'Make Project', or just click the 'Play' button in the tool bar to build and run it in a mobile device or an emulator. The resulting APK file will be saved in the 'build/outputs/apk/' subdirectory in the project folder.
+

 
 

-### 5. Building with Eclipse:
+### 3. Working in a terminal with Gradle:

 
 

-NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable.
+[Gradle][7] is the build system used by Android Studio to manage the building operations on Android apps. You do not need to install Gradle in your system, and Google recommends not to do it, but instead trusting on the Graddle wrapper included in the project [8].

 
 

+* Open a terminal and go to the 'android' directory that contains the repository.
+* Complete the setup of project properties running:
+    - Windows: ```setup_env.bat gradle```
+    - Mac OS/Linux: ```./setup_env.sh gradle```
+* Run the 'clean' and 'build' tasks using the Gradle wrapper provided
+    - Windows: ```gradlew.bat clean build```
+    - Mac OS/Linux: ```./gradlew clean build```
+       
+The first time the Gradle wrapper is called, the correct Gradle version will be downloaded automatically. An Internet connection is needed for it works.
+       
+The generated APK file is saved in android/build/outputs/apk as android-debug.apk
+
+
+### 4. Building with Eclipse:
+
+[Eclipse][9] is still an option to work with Android apps, although the [ADT Plugin][10] needed is not in active development anymore. Next steps have been tested in Eclipse Luna.
+
+* Open a terminal and go to the 'android' directory that contains the repository.

 * Resolve necessary dependencies running:
 * Resolve necessary dependencies running:

-    - Windows: "setup_env.bat ant"
-    - Mac OS/Linux: "./setup_env.sh ant"
-    * Open Eclipse and create new "Android Project from Existing Code". Choose android/actionbarsherlock/library as root.
-* Clean project and compile.
-* If any error appears, check the project properties; in the 'Android' section, API Level should be greater or equal than 14.
-* 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.
-* Clean project and compile.
-* If any error appears, 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.
-* Import ownCloud Android project.
-* Clean project and compile.
-* If any error appears, check the project properties of owncloud-android project; in the 'Android' section:
-    - API Level should be 19 or greater.
-    - Two library projects should appear referred in the bottom square: actionbarsherlock/library and owncloud-android-library. Add them if needed.
+    - Windows: ```setup_env.bat ant```
+    - Mac OS/Linux: ```./setup_env.sh ant```
+* Open Eclipse and follow the menu path 'File'/'New'/'Project'
+* Choose the option 'Android'/'Android Project from Existing Code' and click 'Next'
+* Choose 'android/' folder as root
+* Choose the projects with the next names under the 'New Project Name' column:
+** owncloud-android 
+** android-support-appcompat-v7-exploded-aar
+** owncloud-android-workaround-accounts        (optional)
+** ownCloud Android Library
+** ownCloud Sample Client (optional)
+** ownCloud Android library test project (optional)
+** ownCloud Android library test cases (optional)
+* Do not choose the project owncloud-android-tests; it's obsolete.
+* Do not enable 'Copy projects into workspace'.
+* Click the 'Finish' button.   
+* Wait for a while; if 'Build automatically' is enabled in Eclipse, some errors could appear during the creation of the projects, but all of them should finally disappear.
+* If any error persists, clean and build manually the next projects in order:
+** ownCloud Android Library
+** android-support-appcompat-v7-exploded-aar
+** owncloud-android
+* If any error on those projects persists, check the project properties. In the 'Android' section, API Level should be
+** ownCloud Android Library    -> API level 19
+** android-support-appcompat-v7-exploded-aa -> API level 22
+** owncloud-android    -> API level 22 ; in this project, two library projects should appear referred in the bottom of the dialog: libs\android-support-appcompat-v7-exploded-aar and owncloud-android-library. Add them if needed.

 * After those actions you should be good to go. HAVE FUN!
 
 * After those actions you should be good to go. HAVE FUN!
 

-NOTE: Even though API level is set to 19, APK also runs on older devices because in AndroidManifest.xml minSdkVersion is set to 8.

 
 

-### 6. Building with Android Studio:
+### 5. Building in command line with Ant:

 
 

-* Complete the setup of project properties running:
-    - Windows: "setup_env.bat gradle"
-    - Mac OS/Linux: "./setup_env.sh gradle"
-* The first time you want to open the project in Android Studio, select 'Import Project...' and choose the file "android/settings.gradle".
-  Android Studio will then create the '.iml' files it needs. If you ever close the project but the files are still there, you just select
-  'Open Project...'. The file chooser will show an Android face as the folder icon, which you can select to reopen the project.
-* To build the project, follow the guidelines shown on [4. Building with Gradle][2].
+[Ant][10] can be used to build the ownCloud for Android app in a terminal. Be sure that the PATH variable in your environment contains the full path to the 'bin/' subdirectory in your Ant installation. Define also an ANDROID_HOME variable in your environment with the full path to your Android SDK (see section 1). Then follow the next steps:
+
+* Open a terminal and go to the 'android' directory that contains the repository.
+* Resolve necessary dependencies running:
+    - Windows: ```setup_env.bat ant```
+    - Mac OS/Linux: ```./setup_env.sh ant```
+* Run ```ant clean```.
+* Run ```ant debug``` to generate a debuggable version of the ownCloud app.
+
+The resulting APKs will be saved in the 'bin/' subdirectory of the project.

 
 

-### 7. Create pull request:

 
 

-NOTE: You must sign the [Contributor Agreement][1] before your changes can be accepted!
+### 6. Building in command line with maven:

 
 

-* Commit your changes locally: "git commit -a"
-* Push your changes to your GitHub repo: "git push"
-* Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
-* Click "Edit" and set "base:develop"
-* Again, click "Edit" and set "compare:develop"
-* Enter description and send pull request.
+** Currently these build instructions DO NOT WORK. There is no estimation time to fix it. Unless some volunteer contributor fixes this build option, and given that Maven is a minority option in Android environments, we will probably remove this option.
+
+NOTE: You must have mvn (version >= 3.1.1) in your environment path. Current Android 'platforms-tools' need to be installed.

 
 

-### 8. Create another pull request:
+Download/install Android plugin for Maven, then build ownCloud with mvn:

 
 

-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.
+* Resolve necessary dependencies running:
+    - Windows: "setup_env.bat maven"
+    - Mac OS/Linux: "./setup_env.sh maven"
+       
+* cd ..
+* git clone https://github.com/mosabua/maven-android-sdk-deployer.git
+* cd maven-android-sdk-deployer
+* mvn -pl com.simpligility.android.sdk-deployer:android-22 -am install
+* cd ../android/owncloud-android-library
+* mvn install
+* cd ..

 
 

-* git fetch upstream
-* git checkout -b my_new_develop_branch upstream/develop
-* If you want to rename that branch later: "git checkout -b my_new_develop_branch_with_new_name"
-* Push branch to server: "git push -u origin name_of_local_develop_branch"
-* Use GitHub to issue PR
+Now you can create ownCloud APK using "mvn package" and find it as ownCloud.apk under the target

 
 
 [0]: https://github.com/owncloud/android/blob/master/CONTRIBUTING.md
 
 
 [0]: https://github.com/owncloud/android/blob/master/CONTRIBUTING.md

-[1]: http://owncloud.org/about/contributor-agreement/
-[2]: https://github.com/owncloud/android/blob/master/SETUP.md#4-building-with-gradle
+[1]: https://git-scm.com/
+[2]: https://git-scm.com/downloads
+[3]: https://developer.android.com/sdk/index.html
+[4]: https://developer.android.com/sdk/installing/index.html
+[5]: https://developer.android.com/tools/studio/index.html
+[6]: https://developer.android.com/sdk/installing/index.html?pkg=studio
+[7]: https://gradle.org/
+[8]: https://docs.gradle.org/current/userguide/gradle_wrapper.html
+[9]: https://eclipse.org/
+[10]: http://developer.android.com/sdk/installing/installing-adt.html