Completed update of local database and storage after a successful remote move

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

diff --git a/SETUP.md b/SETUP.md
index 102434b..a965064 100644 (file)
--- a/SETUP.md
+++ b/SETUP.md
@@ -12,6 +12,7 @@ NOTE: You must have git in your environment path variable to perform the next op
 * 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"
 * 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"

+* 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. Section 2, 3 and 4 describe some of the existing alternatives.  
 


@@ -19,21 +20,20 @@ At this point you can continue using different tools to build the project. Secti
   
 NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable.
 
   
 NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in your environment path variable.
 

-* Complete the setup of project properties and resolve pending dependencies running "setup_env.bat" or "./setup_env.sh" .

 * Run "ant clean" .
 * Run "ant clean" .

-* Run "ant debug" to generate a debuggable version of the ownCkoud app.
+* Run "ant debug" to generate a debuggable version of the ownCloud app.

 
 ### 3. 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.
 
 
 ### 3. 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.
 

-Download/install Android plugin for Maven, install oc_framework, then build ownCloud with mvn:
+Download/install Android plugin for Maven, install owncloud-android-library, then build ownCloud with mvn:

 
 * 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 ..
 * 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/oc_framework
+* cd ../android/owncloud-android-library

 * mvn install
 * cd ..
 
 * mvn install
 * cd ..
 


@@ -48,15 +48,15 @@ NOTE: You must have the Android SDK 'tools/', and 'platforms-tools/' folders in
 * 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.
 * Make sure android/actionbarsherlock/library/bin/library.jar was created.
 * 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.
 * Make sure android/actionbarsherlock/library/bin/library.jar was created.

-* Create a new "Android Project from Existing Code". Choose android/oc_framework as root.
+* Create a new "Android Project from Existing Code". Choose android/owncloud-android-library as root.

 * Clean project and compile.
 * If any error appear, check the project properties; in the 'Android' section, API Level should be 19 or greater.
 * 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/oc_framework/bin/classes.jar was created.  
+* 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.
 * 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 oc_framework. Add them if needed. 
+  - Two library projects should appear referred in the bottom square: actionbarsherlock/library and owncloud-android-library. Add them if needed. 

 * 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.
 * 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.


@@ -79,7 +79,7 @@ To make sure your new pull request does not contain commits which are already co
 * 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"
 * 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 meaningful_name_for_branch"
+* Push branch to server: "git push -u origin name_of_local_develop_branch"

 * Use Github to issue PR
 
 
 * Use Github to issue PR