spec commit: CB-6550 Add README.md to createmobilespec

[ma...@apache.org]

Repository: cordova-mobile-spec
Updated Branches:
  refs/heads/master 1b7ca6be5 -> c4538b965


CB-6550 Add README.md to createmobilespec


Project: http://git-wip-us.apache.org/repos/asf/cordova-mobile-spec/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-mobile-spec/commit/c4538b96
Tree: http://git-wip-us.apache.org/repos/asf/cordova-mobile-spec/tree/c4538b96
Diff: http://git-wip-us.apache.org/repos/asf/cordova-mobile-spec/diff/c4538b96

Branch: refs/heads/master
Commit: c4538b965f9052eb2604424188cf48afb209b939
Parents: 1b7ca6b
Author: Marcel Kinard <cm...@gmail.com>
Authored: Fri May 23 14:05:51 2014 -0400
Committer: Marcel Kinard <cm...@gmail.com>
Committed: Fri May 23 14:09:02 2014 -0400

----------------------------------------------------------------------
 README.md                  |  2 +-
 createmobilespec/README.md | 74 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-mobile-spec/blob/c4538b96/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 495cba7..393b657 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@
 
 This project is a set of automated & manual tests that test Cordova core functionality.
 
-To set up the project, use `cordova-mobile-spec/createmobilespec/createmobilespec.js`.
+To set up the project, use `cordova-mobile-spec/createmobilespec/createmobilespec.js`. See the README.md in that directory.
 
 ### Requirements ###
 

http://git-wip-us.apache.org/repos/asf/cordova-mobile-spec/blob/c4538b96/createmobilespec/README.md
----------------------------------------------------------------------
diff --git a/createmobilespec/README.md b/createmobilespec/README.md
new file mode 100644
index 0000000..c0cac68
--- /dev/null
+++ b/createmobilespec/README.md
@@ -0,0 +1,74 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+
+## Creating the mobile-spec app
+
+`createmobilespec` is a script for creating a test app that has:
+
+  * the mobile-spec code from the local `cordova-mobile-spec` git repo
+  * a `cordova.js` file that is freshly built from the local `cordova-js`
+    git repo
+  * the platform (i.e., Android) from the local platform git repo (i.e., 
+    `cordova-android`)
+  * all the plugins from the local plugin repos (i.e., cordova-plugin-device)
+  * it was built using the local `cordova-cli` and `cordova-plugman` git repos
+
+In other words, it is a great way to test your local development efforts.
+
+The script also has options for creating the test app using a
+globally-installed npm module, a way to use the platform's `cordova.js` file
+instead of building it from the local `cordova-js` git repo, and a way to
+use the platform-centered workflow instead of the CLI.
+
+### Requirements
+
+See the README.md in the parent directory (cordova-mobile-spec).
+
+Each git repo should be checked out to the state or edited with the content
+that you want to test. It does not download content from the
+[plugin registry](http://plugins.cordova.io)
+nor does it fetch platforms from the npm repository.
+
+Before running `createmobilespec.js` for the first time, run `npm install` from
+within the `createmobilespec` directory to install the requisite third-party
+Node modules. This should be a one-time activity, unless there is a change
+in the pre-reqs.
+
+### Running
+
+The `createmobilespec.js` script needs to be invoked from a specific
+current working directory: the one where you have all the git repos
+cloned. So if you were to do an `ls` in that directory, you should see all
+the git repos including `cordova-mobile-spec`. Thus an invocation should
+look like:
+
+        cordova-mobile-spec/createmobilespec/createmobilespec.js
+
+To see the options available in the script, run it with the `-h` option to
+print the online help.
+
+After you have run the script to create the app, then you can run the app on a
+device or simulator, using the standard method for that platform(s). For
+example on Android:
+
+        cd mobilespec
+        ./cordova run android
+