You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by sh...@apache.org on 2012/08/03 02:51:07 UTC
ios commit: [CB-1186] Update README.md,
FirstRun.md for new install method
Updated Branches:
refs/heads/master 1eb3c2cb3 -> 13ffa9c57
[CB-1186] Update README.md, FirstRun.md for new install method
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/13ffa9c5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/tree/13ffa9c5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/diff/13ffa9c5
Branch: refs/heads/master
Commit: 13ffa9c57a699a452d22f076903baea204b9390b
Parents: 1eb3c2c
Author: Shazron Abdullah <sh...@apache.org>
Authored: Thu Aug 2 17:50:58 2012 -0700
Committer: Shazron Abdullah <sh...@apache.org>
Committed: Thu Aug 2 17:50:58 2012 -0700
----------------------------------------------------------------------
FirstRun.md | 23 +++++++++++++++--------
README.md | 19 ++++++-------------
RELEASENOTES.md | 2 +-
3 files changed, 22 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/13ffa9c5/FirstRun.md
----------------------------------------------------------------------
diff --git a/FirstRun.md b/FirstRun.md
index 77d0a9a..8b2330f 100644
--- a/FirstRun.md
+++ b/FirstRun.md
@@ -18,31 +18,38 @@
# under the License.
#
-->
-## Thanks for installing Cordova {VERSION}!
+## Thanks for installing Cordova!
## Plugins
-* **DO NOT CHECK** the "Automatic Reference Counting" option when creating a new project, if not you will have compile errors.
* Plugins **MUST** add their plugin mapping to their app's Cordova.plist Plugins key, if not they will not work (see your plugin's README)
-* Plugins **MUST** add any external hosts they connect to to the white-list in Cordova.plist/ExternalHosts (add hostnames **only**, NO protocols nor paths)
+* Plugins **MUST** add any external hosts they connect to to the white-list in Cordova.plist/ExternalHosts (add hostnames **only**, NO protocols nor paths) - see the [**Domain Whitelist Guide**](http://docs.phonegap.com/en/edge/guide_whitelist_index.md.html#Domain%20Whitelist%20Guide)
* A plugin's Objective-C code **MUST** be added to the project properly in a "group" (**YELLOW** folder), if you incorrectly added it as a folder reference it would be a blue folder (just delete the reference, and re-add)
-* A lot of plugins have changed their mapping names in Cordova.plist, you might have to copy and use the new Cordova.plist in your app.
+* A lot of plugins have changed their mapping names in **Cordova.plist**, you might have to copy and use the new **Cordova.plist** in your app.
<br />
-## Upgraders
+## Plugin Upgrades
+
+Please see the **Cordova Plugin Upgrade Guide.md** document included in the **guides** sub-folder in the source distribution
+
+<br />
+
+## Project Upgrades
1. Please see the [**Upgrading Cordova iOS**](http://docs.phonegap.com/en/edge/guide_upgrading_index.md.html) document on [http://docs.phonegap.com](http://docs.phonegap.com)
-2. See the FAQ in the README.pdf as well
+2. See the FAQ in the README.md as well included in the source distribution
<br />
+## Install CordovaLib
+
+Please see the instructions in the **README.md** document included in the source distribution
+
## Creating a new Cordova-based project
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 />
That's it! Modify the contents of the "www" directory to add your HTML, CSS and Javascript.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/13ffa9c5/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index df0e9c9..ea202f3 100644
--- a/README.md
+++ b/README.md
@@ -28,23 +28,18 @@ 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).
<br />
-Build and install the Installer Package
+Install CordovaLib
-------------------------------------------------------------
-You don't need to do this if you downloaded the installer from [http://incubator.apache.org/cordova/](http://incubator.apache.org/cordova/), this is only for developers that need to compile the source.
1. Launch **"Terminal.app"**
-2. Navigate to the folder where the Makefile is
+2. Navigate to the folder where you downloaded the source
3. Type in **"make"** then press Enter
-4. **make** will require you to install [Homebrew](http://mxcl.github.com/homebrew/), [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) and [Markdown](http://daringfireball.net/projects/markdown/), in that order - you will have to agree to install them manually, we don't install them automatically. Note for **wkhtmltopdf**, follow the instructions exactly - you'll have to install version **0.9.9** through **make install-wkhtmltopdf**, NOT **brew install wkhtmltopdf**
<br />
-The installer should build "CordovaInstaller.dmg" into the **dist** folder, mount the .dmg, then:
+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.
-1. Quit Xcode
-2. Launch "CordovaInstaller.pkg" from the mounted .dmg, to install CordovaLib, the Cordova framework and the Cordova 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.
+**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"**.
<br />
@@ -86,18 +81,16 @@ Unit Tests
Installer Notes
-------------------------------------------------------------
-This installer will only install items under your home folder (signified by ~)
Items that will be installed:
-1. Xcode global var in _~/Library/Preferences/com.apple.Xcode.plist _ (which will be listed under Xcode Preferences -> Source Trees)
-2. CordovaLib Xcode static library project under _~/Documents/CordovaLib_
+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 files listed above, or use the "Uninstall Cordova" app included in the Cordova iOS DMG file.
+Delete the **CORDOVALIB** variable in **Xcode Preferences ->Source Trees**.
FAQ
---
http://git-wip-us.apache.org/repos/asf/incubator-cordova-ios/blob/13ffa9c5/RELEASENOTES.md
----------------------------------------------------------------------
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
index c349d87..e98797f 100644
--- a/RELEASENOTES.md
+++ b/RELEASENOTES.md
@@ -18,7 +18,7 @@
# under the License.
#
-->
-## Release Notes for Cordova ({VERSION}) ##
+## Release Notes for Cordova ##
Cordova is a static library that enables developers to include the Cordova API in their iOS application projects easily, and also create new Cordova-based iOS application projects through the command-line.