UNPKG

3.99 kBMarkdownView Raw
1<a name="README">[<img src="https://rawgithub.com/jasmine/jasmine/master/images/jasmine-horizontal.svg" width="400px" />](http://jasmine.github.io)</a>
2
3[![Build Status](https://travis-ci.org/jasmine/jasmine.svg?branch=master)](https://travis-ci.org/jasmine/jasmine)
4
5=======
6
7**A JavaScript Testing Framework**
8
9Jasmine is a Behavior Driven Development testing framework for JavaScript. It does not rely on browsers, DOM, or any JavaScript framework. Thus it's suited for websites, [Node.js](http://nodejs.org) projects, or anywhere that JavaScript can run.
10
11Documentation & guides live here: [http://jasmine.github.io](http://jasmine.github.io/)
12For a quick start guide of Jasmine 2.x, see the beginning of [http://jasmine.github.io/edge/introduction.html](http://jasmine.github.io/edge/introduction.html)
13
14Upgrading from Jasmine 1.x? Check out the [2.0 release notes](https://github.com/jasmine/jasmine/blob/v2.0.0/release_notes/20.md) for a list of what's new (including breaking interface changes). You can also read the [upgrade guide](http://jasmine.github.io/2.0/upgrading.html).
15
16## Contributing
17
18Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/master/.github/CONTRIBUTING.md)
19
20## Installation
21
22For the Jasmine NPM module:<br>
23[https://github.com/jasmine/jasmine-npm](https://github.com/jasmine/jasmine-npm)
24
25For the Jasmine Ruby Gem:<br>
26[https://github.com/jasmine/jasmine-gem](https://github.com/jasmine/jasmine-gem)
27
28For the Jasmine Python Egg:<br>
29[https://github.com/jasmine/jasmine-py](https://github.com/jasmine/jasmine-py)
30
31For the Jasmine headless browser gulp plugin:<br>
32[https://github.com/jasmine/gulp-jasmine-browser](https://github.com/jasmine/gulp-jasmine-browser)
33
34To install Jasmine standalone on your local box (where **_{#.#.#}_** below is substituted by the release number downloaded):
35
36* Download the standalone distribution for your desired release from the [releases page](https://github.com/jasmine/jasmine/releases)
37* Create a Jasmine directory in your project - `mkdir my-project/jasmine`
38* Move the dist to your project directory - `mv jasmine/dist/jasmine-standalone-{#.#.#}.zip my-project/jasmine`
39* Change directory - `cd my-project/jasmine`
40* Unzip the dist - `unzip jasmine-standalone-{#.#.#}.zip`
41
42Add the following to your HTML file:
43
44```html
45<link rel="shortcut icon" type="image/png" href="jasmine/lib/jasmine-{#.#.#}/jasmine_favicon.png">
46<link rel="stylesheet" type="text/css" href="jasmine/lib/jasmine-{#.#.#}/jasmine.css">
47
48<script type="text/javascript" src="jasmine/lib/jasmine-{#.#.#}/jasmine.js"></script>
49<script type="text/javascript" src="jasmine/lib/jasmine-{#.#.#}/jasmine-html.js"></script>
50<script type="text/javascript" src="jasmine/lib/jasmine-{#.#.#}/boot.js"></script>
51```
52
53## Supported environments
54
55Jasmine tests itself across many browsers (Safari, Chrome, Firefox, PhantomJS, and new Internet Explorer) as well as node. To see the exact version tests are run against look at our [.travis.yml](https://github.com/jasmine/jasmine/blob/master/.travis.yml)
56
57
58## Support
59
60* Search past discussions: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
61* Send an email to the list: [jasmine-js@googlegroups.com](mailto:jasmine-js@googlegroups.com)
62* View the project backlog at Pivotal Tracker: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)
63* Follow us on Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)
64
65## Maintainers
66
67* [Gregg Van Hove](mailto:gvanhove@pivotal.io), Pivotal Labs
68
69### Maintainers Emeritus
70
71* [Davis W. Frank](mailto:dwfrank@pivotal.io), Pivotal Labs
72* [Rajan Agaskar](mailto:rajan@pivotal.io), Pivotal Labs
73* [Greg Cobb](mailto:gcobb@pivotal.io), Pivotal Labs
74* [Chris Amavisca](mailto:camavisca@pivotal.io), Pivotal Labs
75* [Christian Williams](mailto:antixian666@gmail.com), Cloud Foundry
76* Sheel Choksi
77
78Copyright (c) 2008-2017 Pivotal Labs. This software is licensed under the MIT License.