You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by he...@apache.org on 2012/03/26 20:10:38 UTC
[3/3] webos commit: update README
update README
Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-webos/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-webos/commit/914fb4c4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-webos/tree/914fb4c4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-webos/diff/914fb4c4
Branch: refs/heads/master
Commit: 914fb4c42d1a2f8665ab3345222589874a785e73
Parents: 83770f2
Author: Herm Wong <he...@gmail.com>
Authored: Fri Mar 23 22:26:46 2012 -0700
Committer: Herm Wong <he...@gmail.com>
Committed: Fri Mar 23 22:26:46 2012 -0700
----------------------------------------------------------------------
README.md | 30 +++++++++++++++---------------
1 files changed, 15 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cordova-webos/blob/914fb4c4/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 9e1910d..1416750 100755
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-PhoneGap webOS
+Cordova webOS
=====================================================
-PhoneGap webOS is a skeleton HP webOS application, along with JavaScript wrapper libraries, which allow a developer to build an application for an HP webOS device using web technologies. This same code can be built for iPhone, BlackBerry, Symbian, and more to come ...
+Cordova webOS is a skeleton HP webOS application, along with JavaScript wrapper libraries, which allow a developer to build an application for an HP webOS device using web technologies. This same code can be built for iPhone, BlackBerry, Symbian, and more to come ...
Pre-requisites
-----------------------------------------------------
@@ -8,30 +8,30 @@ You should have VirtualBox (virtual machine software which runs the Palm emulato
Set up your environment and install the skeleton app
-----------------------------------------------------
-Open a terminal, and navigate to the root PhoneGap webOS folder (where this readme.md file is located). A Makefile resides here; running make here will package your application, and install it to either the emulator, or the device. Or you can run make on individual target tasks:
+Open a terminal, and navigate to the root Cordova webOS folder (where this readme.md file is located). A Makefile resides here; running make here will package your application, and install it to either the emulator, or the device. Or you can run make on individual target tasks:
- - `make js` - builds phonegap.js from source javascript files to libs/phonegap.js
- - `make copy_js` - copies libs/phonegap.js to framework/phonegap.js - modify this path if you want phonegap.js in another location
- - `make package` - builds the webOS app (located in framework/) into an webOS .ipk installer package in the phonegap_root/palm/ folder
+ - `make js` - builds Cordova.js from source javascript files to libs/Cordova.js
+ - `make copy_js` - copies libs/Cordova.js to framework/Cordova.js - modify this path if you want Cordova.js in another location
+ - `make package` - builds the webOS app (located in framework/) into an webOS .ipk installer package in the Cordova_root/palm/ folder
- `make deploy` - installs the .ipk package to a device if detected, otherwise the emulator if its running
If a connected webOS device is detected, the application will be installed to the device. If not, and the emulator is running, the application will be installed to the emulator. To run the emulator, search for Palm Emulator.app in the finder, and run it.
-Build your PhoneGap app
+Build your Cordova app
-----------------------------------------------------
-Navigate to `phonegap_root/webOS_new/framework/`; this is where your application will reside. If you have already built a phonegap application on another platform, drop your html,js, css and assets into this folder (starting with the required index.html). Don't forget phonegap.js!
+Navigate to `Cordova_root/webOS_new/framework/`; this is where your application will reside. If you have already built a Cordova application on another platform, drop your html,js, css and assets into this folder (starting with the required index.html). Don't forget Cordova.js!
Just open framework/ in your favourite editor, build your web app, and run the appropriate make command indicated above. Edit appinfo.json to set your app id (see Notes below), version, etc.
-PhoneGap-webOS doesn't need to do any native initialization, but it does fire a `deviceready` that guarantees all the PhoneGap APIs are in place. You can run your code at `deviceready` like so:
+Cordova-webOS doesn't need to do any native initialization, but it does fire a `deviceready` that guarantees all the Cordova APIs are in place. You can run your code at `deviceready` like so:
document.addEventListener('deviceready', function() {
- // do cool PhoneGap things
+ // do cool Cordova things
}, false);
To enable a javascript debug console, open a new terminal window and type:
- phonegap-log app_id
+ Cordova-log app_id
Where the app id is your app id as set in `appinfo.json`
This will tail your log file; it will default to the device if detected, otherwise it will read logs from the emulator.
To log from your JS code, use `console.log`
@@ -40,14 +40,14 @@ Notes & Caveats
-----------------------------------------------------
- In order to use the vibration API on palm, your application needs to have a "com.palm.*" namespace, as vibration on webOS is a private API. The caveat of doing this is that you are essentially indicating that your app should pretend to be a "Palm app" (rather than a Nitobi app, for example) ... and as a result your app will be denied from the Palm app catalog.
- Currently the map.show function can only accept one position, as Palm uses google maps as its native maps application, and it only can take one marker as a parameter.
- - Touch event not supported, natively. PhoneGap now includes event handlers for mouse & touch events - please see the example app bundled with PhoneGap-webOS
+ - Touch event not supported, natively. Cordova now includes event handlers for mouse & touch events - please see the example app bundled with Cordova-webOS
- If using Lawnchair, the only supported adaptor is webkitsqlite.
- - html select boxes are implemented by phonegap, not supported natively (believe it or not). only the most basic functionality is implemented, so be aware using this control could cause problems.
+ - html select boxes are implemented by Cordova, not supported natively (believe it or not). only the most basic functionality is implemented, so be aware using this control could cause problems.
- To enable verbose logging, add the file framework_config.json to your framework/www/ folder, containing the following json content: { "logLevel": 99 }
Helpful Links
-----------------------------------------------------
- - PhoneGap API Docs: [docs.phonegap.com](http://docs.phonegap.com)
- - PhoneGap Wiki: [phonegap.pbworks.com](http://phonegap.pbworks.com)
+ - Cordova API Docs: [docs.phonegap.com](http://docs.phonegap.com)
+ - Cordova Wiki: [phonegap.pbworks.com](http://phonegap.pbworks.com)
- Palm webOS developer site: [developer.palm.com](http://developer.palm.com)