Skip to content

Commit

Permalink
doc: readme improvements (cleaup, xcode debugging, etc) (#1133)
Browse files Browse the repository at this point in the history
Co-authored-by: Niklas Merz <NiklasMerz@gmx.net>
Co-authored-by: エリス <erisu@users.noreply.github.com>
  • Loading branch information
3 people committed Oct 2, 2021
1 parent 6e9e593 commit 922c43f
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Expand Up @@ -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:

Expand All @@ -47,20 +47,24 @@ 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
npm install
npm test
```

## Futher reading
## Further reading

* [https://cordova.apache.org/](https://cordova.apache.org/)
* [Apache Cordova](https://cordova.apache.org/)

0 comments on commit 922c43f

Please sign in to comment.