Updated README for 2.1.0rc1
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/commit/964c5c00 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/tree/964c5c00 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/diff/964c5c00 Branch: refs/heads/master Commit: 964c5c00d626aeec1cf96c2c1799b001c6a4e8c1 Parents: a864199 Author: Shazron Abdullah <shaz...@apache.org> Authored: Fri Aug 24 17:59:12 2012 -0700 Committer: Shazron Abdullah <shaz...@apache.org> Committed: Fri Aug 24 17:59:12 2012 -0700 ---------------------------------------------------------------------- README.md | 43 ++++++++++++++++++++++++------------------- 1 files changed, 24 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/964c5c00/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index ea202f3..84f8788 100644 --- a/README.md +++ b/README.md @@ -25,40 +25,51 @@ CordovaLib is a static library that enables users to include Cordova in their iO Pre-requisites ------------------------------------------------------------- -Make sure you have installed the latest released iOS SDK which comes with Xcode 4. Download it at [http://developer.apple.com/ios](http://developer.apple.com/ios). +Make sure you have installed the latest released iOS SDK which comes with Xcode 4. Download it at [http://developer.apple.com/downloads](http://developer.apple.com/downloads) or the [Mac App Store](http://itunes.apple.com/us/app/xcode/id497799835?mt=12). <br /> Install CordovaLib ------------------------------------------------------------- -1. Launch **"Terminal.app"** -2. Navigate to the folder where you downloaded the source -3. Type in **"make"** then press Enter +1. Download the source +2. Extract to their final location +3. There is no step 3 <br /> -This sets the $(CORDOVALIB) variable to the CordovaLib folder of the downloaded source - and is used by Cordova projects to locate the CordovaLib project. If you move this folder, you will need to run **"make"** again to update the location. - -**NOTE:** For 2.0.0, the use of Xcode Templates has been removed. If you don't plan on using older Cordova versions, you should run the uninstaller first - **"make uninstall"**. +**NOTE:** For 2.x and greater, the use of Xcode Templates has been removed. If you don't plan on using older Cordova versions, you should run the uninstaller first - **"make uninstall"**. <br /> Create a Cordova project ------------------------------------------------------------- -1. Copy the **bin** subfolder (included in the distribution) to a location on your hard drive. -2. Follow the instructions in the [**Command-Line Usage** section](http://docs.phonegap.com/en/edge/guide_command-line_index.md.html#Command-Line%20Usage) of [http://docs.phonegap.com](http://docs.phonegap.com) +1. Launch **Terminal.app** +2. Go to the location where you installed Cordova, in the **bin** sub-folder +3. Follow the instructions in the [**Command-Line Usage** section](http://docs.phonegap.com/en/edge/guide_command-line_index.md.html#Command-Line%20Usage) of [http://docs.phonegap.com](http://docs.phonegap.com) The docs should also have been included in the distribution. <br /> +Updating a CordovaLib subproject reference in your project +------------------------------------------------------------- + +Beginning with Cordova 2.1.0, we are not using the CORDOVALIB Xcode variable anymore when referencing where CordovaLib resides, the reference is an absolute file reference now. + +When you update to a new Cordova version, you may need to update the CordovaLib reference in an existing project. Cordova comes with a script that will help you to do this. + +1. Launch **Terminal.app** +2. Go to the location where you installed Cordova, in the **bin** sub-folder +3. Run **"update_cordova_subproject [path/to/your/project/xcodeproj]"** where the first parameter is the path to your project's .xcodeproj file + +<br /> + + Uninstalling CordovaLib, Cordova.framework and the Xcode Templates -------------------------------------------------------------------- -**NOTE:** For 2.0.0, the use of Xcode Templates has been removed. If you don't plan on using older Cordova versions, you should run the uninstaller first. - -Use the "Uninstall Cordova" app included in the Cordova iOS DMG file, OR: +**NOTE:** For 2.x, the use of Xcode Templates has been removed. If you don't plan on using older Cordova versions, you should run the uninstaller first. 1. Launch "Terminal.app" 2. Navigate to the folder where Makefile is (this folder) @@ -82,12 +93,6 @@ Unit Tests Installer Notes ------------------------------------------------------------- -Items that will be installed: - -1. Xcode global variable in _~/Library/Preferences/com.apple.dt.Xcode.plist _ (which will be listed under Xcode Preferences -> Source Trees) - -<br /> - To uninstall: Delete the **CORDOVALIB** variable in **Xcode Preferences ->Source Trees**. @@ -166,7 +171,7 @@ Staring with 2.0.0, you must create projects [using the command line](http://doc **9. In the sub-project based Cordova project, I want to have a project-specific copy of CordovaLib for my project, not a global one. How do I do this?** -In your project, there should be a _CordovaBuildSettings.xcconfig_ file. Modify the _CORDOVALIB_ variable in the file to point to your project specific CordovaLib folder. You can use relative paths, off $(PROJECT_DIR). +Select the CordovaLib subproject in your Project Navigator, and in the File Inspector, choose the new location of the subproject, or see the "**Updating a CordovaLib subproject reference in your project**" section above. **10. In a .framework based Cordova project (only supported in Cordova versions lesser than 2.0.0), I want to have a project-specific copy of Cordova.framework for my project, not a global one. How do I do this?**
