erisu commented on a change in pull request #1308: URL: https://github.com/apache/cordova-android/pull/1308#discussion_r686744255
########## File path: README.md ########## @@ -28,22 +28,44 @@ Cordova Android is an Android application library that allows for Cordova-based projects to be built for the Android Platform. Cordova based applications are, at the core, applications written with web technology: HTML, CSS and JavaScript. -[Apache Cordova](https://cordova.apache.org) is a project of The Apache Software Foundation (ASF). +[Apache Cordova](https://cordova.apache.org/) is a project of [The Apache Software Foundation (ASF)](https://apache.org/). ## Requirements -- Java Development Kit (JDK) 11 -- [Android SDK](https://developer.android.com/) +* Java Development Kit (JDK) 11 +* [Android SDK](https://developer.android.com/) +* [Node.js](https://nodejs.org) -## Cordova Android Developer Tools +## Create a Cordova project -Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins. +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/) -## Using Android Studio +To use a **shared framework**, for example in development, link the appropriate cordova-android platform folder path: -1. Create a project -2. Import it via "Non-Android Studio Project" +```bash +cordova platform add --link /path/to/cordova-android +``` -## Running the Native Tests +## Updating a Cordova project -The `test/` directory in this project contains an Android test project that can be used to run different kinds of native tests. Check out the [README contained therein](test/README.md) for more details! +When you install a new `cordova-cli` version that comes with a new Android platform version, from within your project: Review comment: ```suggestion When you install a new version of the [`Cordova CLI`](https://www.npmjs.com/package/cordova) that pins a new version of the [`Cordova-Android`](https://www.npmjs.com/package/cordova-android) platform, you can follow these simple upgrade steps within your project: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
