From 922c43f2756d6d39c312ae964a1c6ee743fddabc Mon Sep 17 00:00:00 2001 From: Alexis THOMAS Date: Sat, 2 Oct 2021 07:53:02 +0200 Subject: [PATCH] doc: readme improvements (cleaup, xcode debugging, etc) (#1133) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Niklas Merz Co-authored-by: エリス --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5da702dbc..423510d0a 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Cordova iOS is an iOS application library that allows for Cordova-based projects ## Create a Cordova project -Follow the instructions in the [**Command-Line Usage** section](https://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface) of [Apache Cordova Docs](https://cordova.apache.org/docs/en/latest/) +Follow the instructions in the [**Create your first Cordova app**](https://cordova.apache.org/docs/en/latest/guide/cli/index.html) section of [Apache Cordova Docs](https://cordova.apache.org/docs/en/latest/) To use a **shared CordovaLib**, for example in development, link the appropriate cordova-ios platform folder path: @@ -47,13 +47,17 @@ cordova platform add --link /path/to/cordova-ios ## Updating a Cordova project -When you install a new `cordova-cli` version that comes with a new iOS platform version, from within your project: +When you install a new version of the [`Cordova CLI`](https://www.npmjs.com/package/cordova) that pins a new version of the [`Cordova-iOS`](https://www.npmjs.com/package/cordova-ios) platform, you can follow these simple upgrade steps within your project: ```bash cordova platform rm ios cordova platform add ios ``` +## Debugging in Xcode + +Import project in Xcode through _File > Open_ and targeting `/path/to/your-cdv-project/platforms/ios/PROJECT_NAME.xcworkspace`. + ## How to Test Repo Development ```bash @@ -61,6 +65,6 @@ npm install npm test ``` -## Futher reading +## Further reading -* [https://cordova.apache.org/](https://cordova.apache.org/) +* [Apache Cordova](https://cordova.apache.org/)