github-migration/jasmine-headless-webkit
1
0
Fork 0
Code Issues 39 Pull Requests 16 Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
John Bintz 2011-05-03 16:42:16 -04:00
parent 5d0babe89e
commit e06bdb3fcd
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,11 +1,13 @@
# Jasmine Headless WebKit runner # Jasmine Headless WebKit runner
Run your specs at sonic boom speed! No pesky reload button or page rendering slowdowns!
## Introduction ## Introduction
This gem works with projects that have used the [Jasmine gem](https://github.com/pivotal/jasmine-gem) to This gem works with projects that have used the [Jasmine gem](https://github.com/pivotal/jasmine-gem) to
create a `jasmine.yml` file that defines what to test. The runner loads that create a `jasmine.yml` file that defines what to test. The runner loads that
`jasmine.yml` file and executes the tests in a Qt WebKit widget, displaying the results to the console and `jasmine.yml` file and executes the tests defined within in a Qt WebKit widget, displaying the results
setting the exit code to one of the following: to the console and setting the exit code to one of the following:
* 0 for success * 0 for success
* 1 for spec run failure * 1 for spec run failure
@ -13,7 +15,7 @@ setting the exit code to one of the following:
`console.log` works, too, so you can run your specs side-by-side in a browser if you're so inclined. It `console.log` works, too, so you can run your specs side-by-side in a browser if you're so inclined. It
serializes whatever you're passing in as as JSON string, so objects that are cyclical in nature will not serializes whatever you're passing in as as JSON string, so objects that are cyclical in nature will not
serialize. serialize. If anyone has a good solution for this, please suggest and/or fork'n'fix.
## Installation ## Installation
@ -27,6 +29,8 @@ Tested in the following environments:
* Mac OS X 10.6, with MacPorts Qt and Nokia Qt.mpkg * Mac OS X 10.6, with MacPorts Qt and Nokia Qt.mpkg
* Kubuntu 10.10 * Kubuntu 10.10
Let me know via a message or in the Issues section if it works on your setup and it's not listed!
## Usage ## Usage
jasmine-headless-webkit [options] [path to jasmine.yml, defaults to spec/javascripts/support/jasmine.yml] jasmine-headless-webkit [options] [path to jasmine.yml, defaults to spec/javascripts/support/jasmine.yml]
@ -97,4 +101,3 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.