removing leading $ from CLI examples. updated command formats based on Brian's feedback.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/commit/96de0b79 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/tree/96de0b79 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/diff/96de0b79 Branch: refs/heads/cordova-client Commit: 96de0b794fbaa4bd51844d7307999c506c561bcb Parents: 2465069 Author: Mike Reinstein <reinstein.m...@gmail.com> Authored: Tue Sep 11 10:48:19 2012 -0400 Committer: Mike Reinstein <reinstein.m...@gmail.com> Committed: Tue Sep 11 10:48:19 2012 -0400 ---------------------------------------------------------------------- README.md | 30 +++++++++++++++--------------- 1 files changed, 15 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/blob/96de0b79/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index a590f22..d8ff97d 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,20 @@ cd cordova-client sudo npm install -g ``` -the -g flag installs cordova globally, so you can access the tool via `$ cordova` +the -g flag installs cordova globally, so you can access the tool via `scordova` ## Subcommands format | description :------------ | :------------- -`create [directory] <[id]> <[name]>` | create a new cordova project with optional name and id -`platform [ls]` | list all platforms the project will build -`platform add [platform]` | add a platform as a build target for the project -`platform remove [platform]` | removes a platform as a build target for the project -`plugin [ls]` | list all plugins added to the project -`plugin add [path-to-plugin]` | add a plugin to the project -`plugin remove [plugin]` | **NOT IMPLEMENTED!** +`create <directory> [<id> []<name>]]` | create a new cordova project with optional name and id +`platform ls` | list all platforms the project will build +`platform add <platform>` | add a platform as a build target for the project +`platform remove <platform>` | removes a platform as a build target for the project +`plugin ls` | list all plugins added to the project +`plugin add <path-to-plugin>` | add a plugin to the project +`plugin remove <plugin>` | **NOT IMPLEMENTED!** `build` | compile the app for all platforms added to the project `emulate` | launch emulators for all platforms added to the project @@ -87,17 +87,17 @@ Contains the project's web artifacts, such as .html, .css and .js files. These a This example shows how to create a project from scratch named KewlApp with iOS and Android platform support, and includes a plugin named Kewlio. The project will live in ~/MyProjects/KewlApp ``` -$ cordova create ~/KewlApp +cordova create ~/KewlApp -$ cd ~/KewlApp +cd ~/KewlApp -$ cordova platform add ios +cordova platform add ios -$ cordova platform add android +cordova platform add android -$ cordova plugin add http://example.org/Kewlio-1.2.3.tar.gz +cordova plugin add http://example.org/Kewlio-1.2.3.tar.gz -$ cordova build +cordova build ``` The directory structure of KewlApp now looks like this: @@ -118,7 +118,7 @@ The directory structure of KewlApp now looks like this: ## Running Tests - $ npm test + npm test **WARNING**: If you run tests and don't have any sub-directories under `./lib`, be prepared to see some failing tests as then this project will
