erisu commented on a change in pull request #1213: URL: https://github.com/apache/cordova-android/pull/1213#discussion_r680965535
########## File path: README.md ########## @@ -32,18 +32,54 @@ Cordova Android is an Android application library that allows for Cordova-based ## Requirements -- Java Development Kit (JDK) 11 -- [Android SDK](https://developer.android.com/) +* Java Development Kit (JDK) 11 +* [Android SDK](https://developer.android.com/) ## Cordova Android Developer Tools Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins. +However, the following scripts can be used instead: + + ./bin/create [path package activity] ... creates the ./example app or a cordova android project + ./bin/check_reqs ....................... checks that your environment is set up for cordova-android development + ./bin/update [path] .................... updates an existing cordova-android project to the version of the framework Review comment: These scripts have been removed. We are no longer supporting this process. ########## File path: README.md ########## @@ -32,18 +32,54 @@ Cordova Android is an Android application library that allows for Cordova-based ## Requirements -- Java Development Kit (JDK) 11 -- [Android SDK](https://developer.android.com/) +* Java Development Kit (JDK) 11 +* [Android SDK](https://developer.android.com/) ## Cordova Android Developer Tools Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins. +However, the following scripts can be used instead: + + ./bin/create [path package activity] ... creates the ./example app or a cordova android project + ./bin/check_reqs ....................... checks that your environment is set up for cordova-android development + ./bin/update [path] .................... updates an existing cordova-android project to the version of the framework + +These commands live in a generated Cordova Android project. Any interactions with the emulator require you to have an AVD defined. + + ./cordova/clean ........................ cleans the project + ./cordova/build ........................ calls `clean` then compiles the project + ./cordova/log ........................ streams device or emulator logs to STDOUT + ./cordova/run ........................ calls `build` then deploys to a connected Android device. If no Android device is detected, will launch an emulator and deploy to it. + ./cordova/version ...................... returns the cordova-android version of the current project + +To use a **shared CordovaLib**, for example in development, link the appropriate cordova-android platform folder path: Review comment: I am not sure about using the wording `CordovaLib` in this case. I know you said you copied from iOS, but in the iOS repo, the native's framework is called `CordovaLib`. You can even see the `CordovaLib` directory. Android calls it `framework`. `CordovaLib` can also be confusing for some people cause we have a `cordova-lib` repo which is used in the CLI. ########## File path: README.md ########## @@ -32,18 +32,54 @@ Cordova Android is an Android application library that allows for Cordova-based ## Requirements -- Java Development Kit (JDK) 11 -- [Android SDK](https://developer.android.com/) +* Java Development Kit (JDK) 11 +* [Android SDK](https://developer.android.com/) ## Cordova Android Developer Tools Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins. +However, the following scripts can be used instead: + + ./bin/create [path package activity] ... creates the ./example app or a cordova android project + ./bin/check_reqs ....................... checks that your environment is set up for cordova-android development + ./bin/update [path] .................... updates an existing cordova-android project to the version of the framework + +These commands live in a generated Cordova Android project. Any interactions with the emulator require you to have an AVD defined. + + ./cordova/clean ........................ cleans the project + ./cordova/build ........................ calls `clean` then compiles the project + ./cordova/log ........................ streams device or emulator logs to STDOUT + ./cordova/run ........................ calls `build` then deploys to a connected Android device. If no Android device is detected, will launch an emulator and deploy to it. + ./cordova/version ...................... returns the cordova-android version of the current project + +To use a **shared CordovaLib**, for example in development, link the appropriate cordova-android platform folder path: + +```bash +cordova platform add --link /path/to/cordova-android +``` + ## Using Android Studio 1. Create a project 2. Import it via "Non-Android Studio Project" -## Running the Native Tests +## Updating a Cordova project + +When you install a new `cordova-cli` version that comes with a new Android platform version, from within your project: + +```bash +cordova platform rm android +cordova platform add android +``` + +## How to Test Repo Development + +```bash +npm install +npm test +``` + +## Futher reading -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! +* [https://cordova.apache.org/](https://cordova.apache.org/) Review comment: ```suggestion * [Apache Cordova](https://cordova.apache.org/) ``` ########## File path: lib/create.js ########## @@ -229,7 +228,7 @@ exports.create = function (project_path, config, options, events) { .then(function () { return exports.validateProjectName(project_name); }).then(function () { - // Log the given values for the project + // Log the given values for the project Review comment: Generally, I would suggest adding a seperate chore/style PR for these type of changes, but since you are only formatting one line, I guess it is OK ><. ########## File path: README.md ########## @@ -32,18 +32,54 @@ Cordova Android is an Android application library that allows for Cordova-based ## Requirements -- Java Development Kit (JDK) 11 -- [Android SDK](https://developer.android.com/) +* Java Development Kit (JDK) 11 +* [Android SDK](https://developer.android.com/) ## Cordova Android Developer Tools Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins. +However, the following scripts can be used instead: + + ./bin/create [path package activity] ... creates the ./example app or a cordova android project + ./bin/check_reqs ....................... checks that your environment is set up for cordova-android development + ./bin/update [path] .................... updates an existing cordova-android project to the version of the framework + +These commands live in a generated Cordova Android project. Any interactions with the emulator require you to have an AVD defined. + + ./cordova/clean ........................ cleans the project + ./cordova/build ........................ calls `clean` then compiles the project + ./cordova/log ........................ streams device or emulator logs to STDOUT + ./cordova/run ........................ calls `build` then deploys to a connected Android device. If no Android device is detected, will launch an emulator and deploy to it. Review comment: These scripts have been removed. We are no longer supporting this process. ########## File path: README.md ########## @@ -32,18 +32,54 @@ Cordova Android is an Android application library that allows for Cordova-based ## Requirements -- Java Development Kit (JDK) 11 -- [Android SDK](https://developer.android.com/) +* Java Development Kit (JDK) 11 +* [Android SDK](https://developer.android.com/) ## Cordova Android Developer Tools Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins. +However, the following scripts can be used instead: + + ./bin/create [path package activity] ... creates the ./example app or a cordova android project + ./bin/check_reqs ....................... checks that your environment is set up for cordova-android development + ./bin/update [path] .................... updates an existing cordova-android project to the version of the framework + +These commands live in a generated Cordova Android project. Any interactions with the emulator require you to have an AVD defined. + + ./cordova/clean ........................ cleans the project + ./cordova/build ........................ calls `clean` then compiles the project + ./cordova/log ........................ streams device or emulator logs to STDOUT + ./cordova/run ........................ calls `build` then deploys to a connected Android device. If no Android device is detected, will launch an emulator and deploy to it. + ./cordova/version ...................... returns the cordova-android version of the current project Review comment: Eventhough this script still exists, it most likely will be removed in the future. The reason why the script still exists today, is because the CLI command `cordova platforms` calls this script to disiplay the installed platform version. In the future, the CLI will just call directly to the platform's API to return the version. If you decide to exclude adding this, then the entire section is no longer needed so you can also remove the opening: > These commands live in a generated Cordova Android project. Any interactions with the emulator require you to have an AVD defined. -- 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]
