You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2014/05/15 20:21:49 UTC
[2/3] git commit: Remove out-of-date info from README.md
Remove out-of-date info from README.md
Project: http://git-wip-us.apache.org/repos/asf/cordova-app-harness/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-app-harness/commit/469a471c
Tree: http://git-wip-us.apache.org/repos/asf/cordova-app-harness/tree/469a471c
Diff: http://git-wip-us.apache.org/repos/asf/cordova-app-harness/diff/469a471c
Branch: refs/heads/master
Commit: 469a471c52effe0c4f8547ab557c051adf9d6eef
Parents: f02bf4e
Author: Andrew Grieve <ag...@chromium.org>
Authored: Thu May 15 13:54:21 2014 -0400
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Thu May 15 13:54:21 2014 -0400
----------------------------------------------------------------------
README.md | 44 ++++++--------------------------------------
1 file changed, 6 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-app-harness/blob/469a471c/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index a1282e4..b176a25 100644
--- a/README.md
+++ b/README.md
@@ -13,50 +13,25 @@ Primary Goals:
## Building the App Harness
-TLDR - using a Unix environment, run:
+Using a Unix environment, run:
- ./createproject.sh
-
-The manual way:
-
-1. Create a new CLI app:
-
- cordova create CordovaAppHarness com.yourcompany.appharness CordovaAppHarness
-
-1. Add whichever platforms you want (currently only iOS and Android are supported by the underlying plugins: UrlRemap, zip):
-
- cordova platform add android ios
-
-1. Add the following plugins:
-
- * `org.apache.cordova.UrlRemap` (exists in the `UrlRemap` directory)
- * `org.apache.cordova.file`
- * `org.apache.cordova.file-transfer`
- * `com.phonegap.plugins.barcodescanner` (optional - adds barcode scanning)
-
-1. Clone the the `cordova-app-harness` repository.
-1. Copy the `www` directory into the project:
-
- rm -r CordovaAppHarness/www
- cp -a cordova-app-harness/www CordovaAppHarness/www
- cordova prepare
-
-1. Add any plugins that your apps might need.
+ ./createproject.sh DirName
+ cd DirName
+ cordova plugin add PLUGINS_THAT_YOU_WANT
## Features
* Install and launch via `cordova serve`
-* Three-finger swipe to return to main menu
+* Control via http running within the app
+* Use two-finger double-tap, or pinch towards middle to bring up in-app menu.
## Major Unimplemented Features
* Applying app settings (DisallowOverscroll, etc)
* Applying app splashscreen
* Applying app's whitelist
-* Enabling only the plugins that the app has installed
## Major Unimplemented In-App Menu Features
* Inject a JSConsole script tag
* JSHybugger support
-* Simulator-friendly menu gesture (shake gesture?)
## Test by using `cordova serve`
* Go to Cordova project of the app you want to test in a terminal and run.
@@ -66,12 +41,6 @@ The manual way:
* If you are running this on a simulator, you can use `http://localhost` as your address, or on Android `10.0.0.22`.
* If `cordova serve` is on a different network than your App Harness, then use [ProxyLocal](http://proxylocal.com/) or [LocalTunnel](http://progrium.com/localtunnel/) to forward the port.
-## Running an app in the harness
-* Click launch on the installed app
-* See if the app looks as expected
-* Use a 3 finger swipe to access the app menu while testing your app.
-* The context menu that pops up allows you to return to the main screen, restart or update the app, open a Firebug console on the device, or set up remote debugging using Weinre.
-
# Harness Server
A server runs within the app that enables remote control functionality.
@@ -90,7 +59,6 @@ Add or update an app's settings, and then update & launch:
curl -X POST http://$IP_ADDRESS:2424/push?type=serve&name=com.example.YourApp&url=http://$SERVE_HOST_ADDRESS:8000
-
### /menu
Return to main menu: