You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by bh...@apache.org on 2013/07/17 21:26:58 UTC
[1/2] webworks commit: [CB-4287] Update BB10 Readme file
Updated Branches:
refs/heads/3.0.x d273506c8 -> 3b356e1ee
[CB-4287] Update BB10 Readme file
Project: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/commit/f662c272
Tree: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/tree/f662c272
Diff: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/diff/f662c272
Branch: refs/heads/3.0.x
Commit: f662c2721dab7fa67ed1a4849b4c6cdda2d307d9
Parents: d273506
Author: Bryan Higgins <bh...@blackberry.com>
Authored: Wed Jul 17 15:21:47 2013 -0400
Committer: Bryan Higgins <bh...@blackberry.com>
Committed: Wed Jul 17 15:27:23 2013 -0400
----------------------------------------------------------------------
blackberry10/README.md | 113 +++++++++++++-------------------------------
1 file changed, 33 insertions(+), 80 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-blackberry/blob/f662c272/blackberry10/README.md
----------------------------------------------------------------------
diff --git a/blackberry10/README.md b/blackberry10/README.md
index 0129ecf..b7cab73 100644
--- a/blackberry10/README.md
+++ b/blackberry10/README.md
@@ -1,100 +1,53 @@
-# Apache Cordova for BlackBerry 10
+Apache Cordova for BlackBerry 10
+================================
-Apache Cordova is an application development platform which allows mobile applications to be written with web technology: HTML, CSS and JavaScript. Access to device APIs is provided by native plugins.
+Apache Cordova is an application development platform that allows you to use common web technologies, primarily HTML5, JavaScript, and CSS, to create applications for mobile devices. Cordova uses a standard set of APIs to access common device features. Additional plugins allow you to access BlackBerry specific APIs, so that you can extend your application to tightly integrate with the BlackBerry 10 OS.
-This implementation for BlackBerry 10 packages web assets into a BAR file which may be deployed to devices and simulators.
+Requirements
+------------
-## Pre-requisites
+Cordova for BlackBerry has the following software requirements:
-Install the latest BlackBerry 10 NDK:
+- Windows XP (32-bit) or Windows 7 (32-bit and 64-bit) or Mac OSX 10.6.4+
+- node.js (> 0.9.9) [Download node.js now](http://nodejs.org/)
+- BlackBerry 10 Native SDK. [Download the BlackBerry 10 Native SDK now.](http://developer.blackberry.com/native/download/)
-[https://developer.blackberry.com/native/download/](https://developer.blackberry.com/native/download)
+ After installing the native SDK, its tools must be added to your system path. Either manually add the bin directory to your path or run the following scripts:
+ - [Linux/Mac] source [BBNDK directory]/bbndk-env.sh
+ - [Windows] [BBNDK directory]\bbndk-env.bat
-Setup environment variables:
-- [Linux/Mac] `source [BBNDK directory]/bbndk-env.sh`
-- [Windows] `[BBNDK directory]\bbndk-env.bat`
+Setting up your signing keys
+----------------------------
-Install code signing keys:
+Before starting development, you'll need to register for your code signing key and debug token. The signing key allows you to sign your completed app so that you can distribute it through BlackBerry World. The debug token allows you to test an unsigned app on a BlackBerry 10 device. You do not need to create and install the debug token yourself; if you supply the keystore password, the build script will create and install the debug token for you.
-[https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html)
+- [Register for your code signing key now.](https://www.blackberry.com/SignedKeys/codesigning.html)
+- [Set your computer up for code signing. ](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html)
+- [Learn more about debug tokens.](http://developer.blackberry.com/html5/documentation/running_your_bb10_app_2008471_11.html)
-Install node.js:
+Creating your project
+-------------------------
-[http://nodejs.org/](http://nodejs.org/)
+To create a new project, you use the `create` command to set up the folder structure for your app.
-Ensure npm is installed:
+1. On the command line, navigate to the folder where you extracted Cordova.
+2. Run the `create` command using the following syntax:
-More recent versions of Nodejs will come with npm included.
+ bin/create <path-to-project>
-## Getting Started
+This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it.
-Create a new project:
+Adding and managing targets
+---------------------------
-`bin/create <path to project>`
+A target refers to a BlackBerry device or emulator that you will use to test your app. Targets are added directly to your project; you can add multiple targets to your project, each with a unique name. Then, when you want to deploy your app to a particular target, you can simply refer to that target by name when you run your script.
-## Managing Targets
+###Add a target
-A target is a device or simulator which will run the app.
+To add a target, on the command line, type the following command:
-This command will add a new target:
+ <path-to-project>/cordova/target add <name> <ip-address> [-t | --type <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
-`<path to project>/cordova/target add <name> <ip> <device | simulator> [-p | --password <password>] [--pin <devicepin>]`
-
-To remove a target:
-
-`<path to project>/cordova/target remove <name>`
-
-To set a target as default:
-
-`<path to project>/cordova/target default <name>`
-
-## Building
-
-`<path to project>/cordova/build`
-
-A project can be built in debug or release mode.
-
-To run an application in debug mode, a debug token must first be installed on the device. The build script will automatically attempt to generate a token and install it. This requires code signing keys to be installed on the development machine. Debug mode will also enable WebInspector. A prompt will appear with the URL to access WebInspector from a remote machine.
-
-If building in release mode, a unique buildId must be provided, either via command line or by setting it in config.xml.
-
-Here is the build script syntax:
-
-`build command [<target>] [-k | --keystorepass] [-b | --buildId <number>] [-p | --params <json>] [-ll | --loglevel <level>]`
-
-Commands:
-
- release [options]
- Build in release mode. This will sign the resulting bar.
-
- debug [options]
- Build in debug mode.
-
- Options:
-
- -h, --help output usage information
- -k, --keystorepass <password> Signing key password
- -b, --buildId <num> Specifies the build number for signing (typically incremented from previous signing).
- -p, --params <params JSON file> Specifies additional parameters to pass to downstream tools.
- -ll, --loglevel <loglevel> set the logging level (error, warn, verbose)`
-
-## Deploying
-
-To deploy the project to a target, use the run command:
-
-`<path to project>/cordova/run <target>`
-
-## Plugin Management
-
-To add a plugin from a local path, you will first need to run fetch:
-
-`<path to project>/cordova/plugin fetch <path to plugin>`
-
-Now the plugin can be installed by name:
-
-`<path to project>/cordova/plugin install <name>`
-
-Plugins hosted remotely can be installed by name without using fetch. To see a list of available remote plugins use:
-
-`<path to project>/cordova/plugin ls`
+where
+- `<name>` specifies a unique name for the target.
[2/2] webworks commit: [CB-4287] Update BB10 Readme file
Posted by bh...@apache.org.
[CB-4287] Update BB10 Readme file
Project: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/commit/3b356e1e
Tree: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/tree/3b356e1e
Diff: http://git-wip-us.apache.org/repos/asf/cordova-blackberry/diff/3b356e1e
Branch: refs/heads/3.0.x
Commit: 3b356e1ee44c91623bac0c5bdf20f75f635861fb
Parents: f662c27
Author: Bryan Higgins <bh...@blackberry.com>
Authored: Wed Jul 17 15:26:16 2013 -0400
Committer: Bryan Higgins <bh...@blackberry.com>
Committed: Wed Jul 17 15:27:35 2013 -0400
----------------------------------------------------------------------
blackberry10/README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 96 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-blackberry/blob/3b356e1e/blackberry10/README.md
----------------------------------------------------------------------
diff --git a/blackberry10/README.md b/blackberry10/README.md
index b7cab73..658d372 100644
--- a/blackberry10/README.md
+++ b/blackberry10/README.md
@@ -51,3 +51,99 @@ To add a target, on the command line, type the following command:
where
- `<name>` specifies a unique name for the target.
+- `<ip-address>` specifies the ip address of the BlackBerry device or emulator.
+- `-t <device | simulator>` specifies the target type. If not provided, the default value is device.
+- `-p|--password <password>` specifies the password for the device or emulator. This is required only if the device or emulator is password protected.
+- `--pin <device-pin>` specifies the PIN of the BlackBerry device, which identifies that device as a valid host for the debug token. This argument is required only if you are creating a debug token.
+
+###Remove a target
+
+To remove a target, on the command line, type the following command:
+
+ <path-to-project>/cordova/target remove <name>
+
+###Set a target as the default
+
+To specify a specific target as the default, on the command line, type the following command:
+
+ <path-to-project>/cordova/target default <name>
+
+Building your app
+-----------------
+
+To build your app, run the build script. You can build the app in either release mode or in debug mode.
+
+- When you build the app in release mode, you are preparing it for distribution through BlackBerry World. The script packages your app resources and plugins together in a .bar file, then signs the app.
+- When you build the app in debug mode, you are preparing it to be tested. The script packages your app resources and plugins together in a .bar file, but does not sign it. The script can also deploy the app onto a previously defined target. If you have not already created and installed a debug token, you can supply the keystore password, and the build script will create and install the debug token for you as well.
+
+ Debug mode also enables Web Inspector for the app, which allows you to remotely inspect the source code. A prompt displays the URL that you can use to connect to and inspect your app. For more information on using Web Inspector, see [Debugging using Web Inspector](http://developer.blackberry.com/html5/documentation/web_inspector_overview_1553586_11.html).
+
+###Build your app in release mode
+
+To build your app in release mode, on the command line, type the following command:
+
+ <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
+
+where
+
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
+- `-b|--buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
+
+###Build your app in debug mode
+
+To build your app in release mode, on the command line, type the following command:
+
+ <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
+
+where
+
+- `<target>` specifies the name of a previously added target. If `<target>` is not specified, the default target is used, if one has been created. This argument is only required if you want the script to deploy your app to a BlackBerry device or emulator and you have not created a default target. Additionally, if `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications. This password is also used to create your debug token. This argument is only required if you want the script to create and install the debug token for you.
+- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools.
+- `-ll|--loglevel <level>` specifies the log level. The log level may be one of `error`, `warn`, or `verbose`.
+
+Note that all of these parameters are optional. If you have previously defined a default target (and installed a debug token, if that target is a BlackBerry device), you can run the script with no arguments, and the script will package your app and deploy it to the default target. For example:
+
+ <path-to-project>/cordova/build debug
+
+Deploying an app
+-------------------------
+
+You can test your app using either a BlackBerry device or an emulator. Before deploying your app, you must first create a target for the device or emulator you want to deploy your app to.
+
+The run script will first build your app. If you intend to deploy an app to a physical device for testing, you must first install a debug token on that device. If you specify the `--keystorepass <password>` argument when running the run script, the script will create and install the debug token for you. You do not need a debug token to test your app on an emulator, even if that app is unsigned.
+
+To deploy your app to a device or emulator, on a command line type the following command:
+
+ <path-to-project>/cordova/run <target> [--no-build]
+
+where
+- `<target>` specifies the name of a previously added target. If `<target>` is a device, then that device must be connected to your computer by USB connection or be connected to the same Wi-Fi network as your computer.
+
+- `-no--build` will use the most recently built version of the application rather than re-building. This is useful to test an application in release mode.
+
+Adding and managing plugins
+---------------------------
+
+To add additional functionality that is outside of the core features of Cordova, you'll need to add plugins. A plugin represents a set of APIs that provide access to additional features of the platform.
+
+In order to use a plugin, you must first add it into your project. Once added into your project, the plugin will be bundled with your project during the build process, to ensure that your app has access to all the APIs it needs.
+
+###Add a plugin
+
+To add a plugin, on the command line, type the following command:
+
+ <path-to-project>/cordova/plugin add <path to plugin>
+
+###Remove a plugin
+
+To remove a plugin, on the command line, type the following command:
+
+ <path-to-project>/cordova/plugin rm <name>
+
+###View a list of installed plugins
+
+To view a list of installed plugins, on the command line, type the following command:
+
+ <path-to-project>/cordova/plugin ls