Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 81 lines (45 sloc) 3.104 kb
3892a8d welcome to ripple
Gord Tanner (macbook) authored
1 # Ripple
2
3 A browser based, platform agnostic mobile application development and testing tool.
4
5 All source code (excluding third party libraries) are subject to:
6
736a4f2 Small edit to remove useless statement...
Ken Wallis authored
7 Copyright (c) 2011 Research In Motion Limited
3892a8d welcome to ripple
Gord Tanner (macbook) authored
8
742e7ee added license blurb
Ken Wallis authored
9 ## License
10
11 All assets in this repository, unless otherwise stated through sub-directory LICENSE or NOTICE files, are subject to the Apache Software License v.2.0.
12
bcf5edf better link?
Ken Wallis authored
13 In particular, the assets under ext/assets/images are excluded from the Apache Software License v.2.0. Please see the [NOTICE](https://github.com/blackberry/Ripple-UI/tree/master/ext/assets/images) file for more details.
742e7ee added license blurb
Ken Wallis authored
14
3892a8d welcome to ripple
Gord Tanner (macbook) authored
15 ## Build Requirements
16
17 * nodejs, npm
18 * OSX or linux (windows is not currently supported for development)
19
20 ## Getting Started
21
22 ./configure
23
24 This script will pull down the needed npm packages and initialize the submodules.
25
26 ## Build Commands
27
28 jake
29
eed8edb @brentlintner updated readme
brentlintner authored
30 This will build ripple to the pkg/ folder. In that folder there is a web directory and a chromium directory.
3892a8d welcome to ripple
Gord Tanner (macbook) authored
31
32 To test ripple as an extension in chrome/chromium just load the chromium folder as an unpacked extension.
33
34 jake -T
35
93cd2ec @brentlintner There is inconsistent grammar in the README.
brentlintner authored
36 This will describe all the available commands for building and running the tests.
3892a8d welcome to ripple
Gord Tanner (macbook) authored
37
babec03 @gtanner better instructions for running as a chrome extension
gtanner authored
38 ## Running as a Chrome Extension
39
93cd2ec @brentlintner There is inconsistent grammar in the README.
brentlintner authored
40 * Go to the extension management page (chrome://chrome/extensions/) in chrome.
41 * Ensure that you have selected the developer mode checkbox.
42 * Click the Load Unpacked extension button.
43 * Select the chromestore folders in the pkg/ folder.
babec03 @gtanner better instructions for running as a chrome extension
gtanner authored
44
93cd2ec @brentlintner There is inconsistent grammar in the README.
brentlintner authored
45 NOTE: For development you should be fine to just build with jake and refresh your browser.
46 If you end up editing anything in the ext folder you will need to refresh the extension from the extension management page.
babec03 @gtanner better instructions for running as a chrome extension
gtanner authored
47
6fff102 @brentlintner updated readme- how to get running in other browsers
brentlintner authored
48 ## Running Inside Other Web Browsers
49
50 Ripple is (by-design) browser agnostic, and is able to run inside any web browser (with disabled web security).
51
6b4d7ed @brentlintner Mentioning that Ripple is only tested in Chrome could be more detailed.
brentlintner authored
52 However, this has (for the most part) only been used in Chrome (and as a result certain things are used that are not supported/tested in other browsers).
53
6fff102 @brentlintner updated readme- how to get running in other browsers
brentlintner authored
54 To get it running inside Chrome you should start it with these [command line](http://www.chromium.org/developers/how-tos/run-chromium-with-flags) flags:
55
56 --app=http://path/to/ripple-ui/pkg/web
57 --disable-web-security
58 --user-data-dir=/path/to/dummy/profile
59
5852b7c @brentlintner As an external dev, there is no info on contributing, and how to do so.
brentlintner authored
60 ## Contributing
61
62 The `master` branch is the latest (stable) release. The `next` branch is where all development happens.
63
64 If you like the project, and want to contribute code, please issue a pull request (on [GitHub](https://github.com/blackberry/Ripple-UI/pulls)) into the `next` branch.
65
66 Note: You will need to be an [official contributor](http://blackberry.github.com/howToContribute.html) before your code can be accepted.
67
3892a8d welcome to ripple
Gord Tanner (macbook) authored
68 ## Code Guidelines
69
93cd2ec @brentlintner There is inconsistent grammar in the README.
brentlintner authored
70 * 4 spaces per editor tab.
71 * `jake lint`, no new lint errors introduced.
72 * All unit tests are green.
eed8edb @brentlintner updated readme
brentlintner authored
73
74 ## Reference Material & Community
75
76 You can also find associated reference material for the Ripple tool as well as contributor forums at the following locations.
77
78 * [Contributor Forums](http://supportforums.blackberry.com/t5/Ripple-Contributions/bd-p/ripple)
79 * [Documentation](http://rippledocs.tinyhippos.com/index.html)
80
Something went wrong with that request. Please try again.