You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by br...@apache.org on 2020/06/24 17:19:32 UTC
[cordova-mobile-spec] branch brodybits-fix-usage-documentation
created (now 2dabc69)
This is an automated email from the ASF dual-hosted git repository.
brodybits pushed a change to branch brodybits-fix-usage-documentation
in repository https://gitbox.apache.org/repos/asf/cordova-mobile-spec.git.
at 2dabc69 fix usage documentation
This branch includes the following new commits:
new 2dabc69 fix usage documentation
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-mobile-spec] 01/01: fix usage documentation
Posted by br...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
brodybits pushed a commit to branch brodybits-fix-usage-documentation
in repository https://gitbox.apache.org/repos/asf/cordova-mobile-spec.git
commit 2dabc69f93804b59d062f5b64c5c6f72d4f9bbae
Author: Chris Brody <ch...@gmail.com>
AuthorDate: Wed Jun 24 13:19:22 2020 -0400
fix usage documentation
---
createmobilespec/README.md | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/createmobilespec/README.md b/createmobilespec/README.md
index a85e2dd..b7fb6e9 100644
--- a/createmobilespec/README.md
+++ b/createmobilespec/README.md
@@ -60,30 +60,32 @@ and a way to use the platform-centered workflow instead of the CLI.
## Usage
-The `createmobilespec.js` script also needs to be invoked from the "main" folder you created before (`cordova`):
+The `createmobilespec.js` script also needs to be invoked from the "main" folder you created before (`cordova`).
- cordova-mobile-spec/createmobilespec/createmobilespec.js
+To show formal usage (online help):
-On Windows, prefix all commands with `node`:
-
- node cordova-mobile-spec/createmobilespec/createmobilespec.js
+ node ./cordova-mobile-spec/createmobilespec/createmobilespec.js --help
-To see the options available in the script, run it with the `-h` option to print the online help.
+The `node` prefix on all commands is only needed on Windows, may be removed on other systems. For example:
- (node) cordova-mobile-spec/createmobilespec/createmobilespec.js -h
+ ./cordova-mobile-spec/createmobilespec/createmobilespec.js --help
-If anything is going wrong and the existing output does not help, add the `--debug` parameter:
+On Windows, prefix all commands with `node`:
- (node) cordova-mobile-spec/createmobilespec/createmobilespec.js --debug
+ node cordova-mobile-spec/createmobilespec/createmobilespec.js
### Create the App
Caution: If the generated `mobilespec` project already exists, it is recommended
to delete the project before proceeding.
-To for example create the app for the Android platform, run:
+To create the app for the Android platform, for example, run:
+
+ node ./cordova-mobile-spec/createmobilespec/createmobilespec.js --android
+
+In case anything is going wrong and the existing output does not help, add the `--debug` parameter:
- (node) cordova-mobile-spec/createmobilespec/createmobilespec.js --android
+ node ./cordova-mobile-spec/createmobilespec/createmobilespec.js --android --debug
### Run the App
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org