diff --git a/README.md b/README.md index 61ff4538..787874fa 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -#BlackBerry 10 WebWorks Framework +# BlackBerry 10 WebWorks Framework WebWorks is an application framework and packaging tool that allows a developer to create a standalone BlackBerry application using HTML5/CSS/JavaScript. Web developers can create a device application experience, including AppWorld distribution and monetization to system security policy enforcement, to deep device system and service integration. All using the technologies they are familiar with, leveraging the power of the industry leading web platform being built for BlackBerry 10. This repo contains the code for the BlackBerry 10 WebWorks Framework. -##Prerequisites +## Prerequisites 1. Install [node[v0.6.10] and npm](http://nodejs.org/dist/v0.6.10/) and add to path. 2. Install [BlackBerry Native SDK](https://bdsc.webapps.blackberry.com/native/). 3. [*Windows*] Add Git bin to PATH. i.e. `*Installation Directory*\bin` -##Setup and Build +## Setup and Build 1. `git clone https://github.com/blackberry-webworks/BB10-WebWorks-Framework.git` 2. `cd BB10-WebWorks-Framework` 3. `git checkout master` @@ -20,7 +20,7 @@ This repo contains the code for the BlackBerry 10 WebWorks Framework. 6. Run `jake` or `jake build` and check that the output folder is created under the "target/zip" subfolder. If on windows, run jake from command prompt. 8. Run `jake test` and check that jake runs and completes -##Running Tests +## Running Tests 1. `jake test` - to run js tests using nodejs 2. `jake native-test` - to run native unit tests 1. To setup run jake upload-ssh-key[,] eg. `jake upload-ssh-key[169.254.0.1,~/.ssh/id_rsa.pub]` @@ -30,7 +30,7 @@ This repo contains the code for the BlackBerry 10 WebWorks Framework. eg: `jake deploy-tests[/Users/jheifetz/Downloads/BB10webworks-next-42/,-d,device,169.254.0.1,qaqa]`

*Note: To see a full list of commands available with jake, use `jake -T`.* -##Common issues +## Common issues ``` Cloning into dependencies/webplatform... error: Couldn't resolve host 'github.rim.net' while accessing http://github.rim.net/webworks/webplatform.git/info/refs diff --git a/dependencies/test-server/README.md b/dependencies/test-server/README.md index e78f801b..91b7a47d 100644 --- a/dependencies/test-server/README.md +++ b/dependencies/test-server/README.md @@ -1,4 +1,4 @@ -#BB10 WebWorks Jasmine Functional Tests +# BB10 WebWorks Jasmine Functional Tests #### Automated Testing on a Blackberry Tablet ### Requirements diff --git a/test/test-app/README.md b/test/test-app/README.md index 66c954d5..c3055c1e 100644 --- a/test/test-app/README.md +++ b/test/test-app/README.md @@ -1,19 +1,19 @@ -#Functional Tests Application - +# Functional Tests Application + run 'jake -T' to see how to use the jake functional test commands -'jake test-app', all tests and dependencies are copied into this application, packagable zip file is produced +'jake test-app', all tests and dependencies are copied into this application, packagable zip file is produced 'jake deploy-tests' builds test application with packager specified and deploys appliation to the device specified - -##Adding new tests - - Automatic functional tests should have their own file in /test/functional/automatic/ - - Manual functional tests should have their own file in /test/functional/manual/ - -##Updating the test application (from root folder of application) - - in config.xml, whitelist the extension you are testing - -To have jasmine tests (automatic or manual) run in this application you must update the corresponding SpecRunner.htm file -Note: You do not have to move your test files from /test/functional to the spec folder in the project directory of the application (they will be moved there when you run jake) - -- in /automatic/SpecRunner.htm add a line including your automatic tests from the /automatic/spec/ folder (inside a script tag) -- in /manual/framework/SpecRuner.htm add a line including your manual tests from the /manual/framework/spec/ folder (inside a script tag) + +## Adding new tests + - Automatic functional tests should have their own file in /test/functional/automatic/ + - Manual functional tests should have their own file in /test/functional/manual/ + +## Updating the test application (from root folder of application) + - in config.xml, whitelist the extension you are testing + +To have jasmine tests (automatic or manual) run in this application you must update the corresponding SpecRunner.htm file +Note: You do not have to move your test files from /test/functional to the spec folder in the project directory of the application (they will be moved there when you run jake) + +- in /automatic/SpecRunner.htm add a line including your automatic tests from the /automatic/spec/ folder (inside a script tag) +- in /manual/framework/SpecRuner.htm add a line including your manual tests from the /manual/framework/spec/ folder (inside a script tag)