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 2020/07/23 14:08:44 UTC
[GitHub] [cordova-cli] timbru31 commented on a change in pull request #402: Tiny CLI docs improvements
timbru31 commented on a change in pull request #402:
URL: https://github.com/apache/cordova-cli/pull/402#discussion_r459477492
##########
File path: README.md
##########
@@ -26,47 +26,53 @@
[](https://github.com/apache/cordova-cli/actions?query=branch%3Amaster)
[](https://codecov.io/github/apache/cordova-cli?branch=master)
-> The command line tool to build, deploy and manage [Cordova](http://cordova.apache.org)-based applications.
+> The command line tool to build, deploy and manage [Cordova](https://cordova.apache.org)-based applications.
-[Apache Cordova](http://cordova.apache.org) allows for building native mobile applications using HTML, CSS and JavaScript.
+[Apache Cordova](https://cordova.apache.org) allows for building native mobile applications using HTML, CSS and JavaScript.
This tool helps with management of multi-platform Cordova applications as well as Cordova plugin integration.
-# Installation
-In your command-line on Windows:
-```bash
+## Installation
+
+In your command-line on Windows:
+
+```bash
c:\> npm install -g cordova
-```
-
+```
+
In your terminal on Mac OS X/Linux:
-```bash
+
+```bash
$sudo npm install -g cordova
```
-# Creating a new Cordova project
+## Creating a new Cordova project
+
This simple example demonstrates how Cordova CLI can be used to create a `myApp` project with the `camera` plugin and run it for `android` platform:
```bash
cordova create myApp com.myCompany.myApp myApp
cd myApp
cordova plugin add cordova-plugin-camera --save
cordova platform add android --save
- cordova requirements android
+ cordova requirements android
cordova build android --verbose
cordova run android
```
-# Docs
+## Docs
+
- [Overview of Cordova]
- [Create your first Cordova app] guide
-- [Full reference docs for Cordova CLI][Reference docs] has details of commands to add platforms, add plugins, build, package, and sign your HTML, JS apps.
+- [Full reference docs for Cordova CLI][Reference docs] has details of commands to add platforms, add plugins, build, package, and sign your HTML, JS apps.
- Cordova allows you to build apps for a number of platforms. Learn more about our [Supported platforms].
- [Project directory structure] documents the details of the directory structure created by Cordova CLI.
-# Contributing
-Cordova is an open source Apache project and contributors are needed to keep this project moving forward. Learn more on
-[how to contribute on our website][contribute].
+## Contributing
+
+Cordova is an open source Apache project and contributors are needed to keep this project moving forward. Learn more on
+[how to contribute on our website][contribute].
-# Reporting Issues
+## Reporting Issues
If you find issues with the Cordova CLI, please follow our guidelines for [reporting issues]. Please bear in mind that most of `cordova-cli`'s functionality is implemented in [cordova-lib], so that could be the place to report your issue.
Platform-specific issues should be reported in the relevant repositories, such as [cordova-android] and [cordova-ios].
Review comment:
Those links do not work either
##########
File path: README.md
##########
@@ -26,47 +26,53 @@
[](https://github.com/apache/cordova-cli/actions?query=branch%3Amaster)
[](https://codecov.io/github/apache/cordova-cli?branch=master)
-> The command line tool to build, deploy and manage [Cordova](http://cordova.apache.org)-based applications.
+> The command line tool to build, deploy and manage [Cordova](https://cordova.apache.org)-based applications.
-[Apache Cordova](http://cordova.apache.org) allows for building native mobile applications using HTML, CSS and JavaScript.
+[Apache Cordova](https://cordova.apache.org) allows for building native mobile applications using HTML, CSS and JavaScript.
This tool helps with management of multi-platform Cordova applications as well as Cordova plugin integration.
-# Installation
-In your command-line on Windows:
-```bash
+## Installation
+
+In your command-line on Windows:
+
+```bash
c:\> npm install -g cordova
-```
-
+```
+
In your terminal on Mac OS X/Linux:
-```bash
+
+```bash
$sudo npm install -g cordova
```
-# Creating a new Cordova project
+## Creating a new Cordova project
+
This simple example demonstrates how Cordova CLI can be used to create a `myApp` project with the `camera` plugin and run it for `android` platform:
```bash
cordova create myApp com.myCompany.myApp myApp
cd myApp
cordova plugin add cordova-plugin-camera --save
cordova platform add android --save
- cordova requirements android
+ cordova requirements android
cordova build android --verbose
cordova run android
```
-# Docs
+## Docs
+
- [Overview of Cordova]
- [Create your first Cordova app] guide
-- [Full reference docs for Cordova CLI][Reference docs] has details of commands to add platforms, add plugins, build, package, and sign your HTML, JS apps.
+- [Full reference docs for Cordova CLI][Reference docs] has details of commands to add platforms, add plugins, build, package, and sign your HTML, JS apps.
- Cordova allows you to build apps for a number of platforms. Learn more about our [Supported platforms].
- [Project directory structure] documents the details of the directory structure created by Cordova CLI.
-# Contributing
-Cordova is an open source Apache project and contributors are needed to keep this project moving forward. Learn more on
-[how to contribute on our website][contribute].
+## Contributing
+
+Cordova is an open source Apache project and contributors are needed to keep this project moving forward. Learn more on
+[how to contribute on our website][contribute].
Review comment:
This links does not work I assume.
----------------------------------------------------------------
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.
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