You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@cordova.apache.org by GitBox <gi...@apache.org> on 2021/08/02 15:44:42 UTC

[GitHub] [cordova-android] ath0mas opened a new pull request #1308: (WIP) update Readme to align with cdv-ios

ath0mas opened a new pull request #1308:
URL: https://github.com/apache/cordova-android/pull/1308


   <!--
   Please make sure the checklist boxes are all checked before submitting the PR. The checklist is intended as a quick reference, for complete details please see our Contributor Guidelines:
   
   http://cordova.apache.org/contribute/contribute_guidelines.html
   
   Thanks!
   -->
   
   ### Platforms affected
   Android
   
   
   ### Motivation and Context
   <!-- Why is this change required? What problem does it solve? -->
   <!-- If it fixes an open issue, please link to the issue here. -->
   Dev and test doc not up to date.
   
   
   ### Description
   <!-- Describe your changes in detail -->
   Remove deprecated parts and reuse some from cordova-ios Readme.
   
   
   ### Testing
   <!-- Please describe in detail how you tested your changes. -->
   .
   
   
   ### Checklist
   
   - [x] I've run the tests to see all new and existing tests pass
   - [x] I added automated test coverage as appropriate for this change
   - [x] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
   - [x] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
   - [x] I've updated the documentation if necessary
   


-- 
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: issues-unsubscribe@cordova.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org

[GitHub] [cordova-android] ath0mas commented on pull request #1308: doc: update README about development & testing

Posted by GitBox <gi...@apache.org>.
ath0mas commented on pull request #1308:
URL: https://github.com/apache/cordova-android/pull/1308#issuecomment-898284238


   Afk for few more days ; I'll do same suggested changes on my PR for cordova-ios or if you want to apply them too feel free 😉


-- 
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: issues-unsubscribe@cordova.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org

[GitHub] [cordova-android] erisu merged pull request #1308: doc: update README about development & testing

Posted by GitBox <gi...@apache.org>.
erisu merged pull request #1308:
URL: https://github.com/apache/cordova-android/pull/1308


   


-- 
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: issues-unsubscribe@cordova.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org

[GitHub] [cordova-android] erisu commented on a change in pull request #1308: Update Readme about dev and test

Posted by GitBox <gi...@apache.org>.
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:
       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:

##########
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/)

Review comment:
       ```suggestion
   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/)
   ```




-- 
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: issues-unsubscribe@cordova.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org

[GitHub] [cordova-android] erisu commented on a change in pull request #1308: Update Readme about dev and test

Posted by GitBox <gi...@apache.org>.
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: issues-unsubscribe@cordova.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org