README updates

* Replaced redundant installation instructions with link to docs
* Added links to usage instructions
* Fixes #1941
This commit is contained in:
Steve Gravrock
2022-04-09 11:20:54 -07:00
parent fb639d0f55
commit d2bf6062cb

View File

@@ -20,37 +20,20 @@ Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/ma
## Installation ## Installation
For the Jasmine NPM module:<br> There are several different ways to install Jasmine, depending on your
[https://github.com/jasmine/jasmine-npm](https://github.com/jasmine/jasmine-npm). environment and how you'd like to use it. See the [Getting Started page](https://jasmine.github.io/pages/getting_started.html)
for details.
For the Jasmine browser runner:<br> ## Usage
[https://github.com/jasmine/jasmine-browser](https://github.com/jasmine/jasmine-browser).
To install Jasmine standalone on your local box (where **_{#.#.#}_** below is substituted by the release number downloaded): See the [documentation site](https://jasmine.github.io/pages/docs_home.html),
particularly the [Your First Suite tutorial](https://jasmine.github.io/tutorials/your_first_suite)
* Download the standalone distribution for your desired release from the [releases page](https://github.com/jasmine/jasmine/releases). for information on writing specs.
* Create a Jasmine directory in your project. - `mkdir my-project/jasmine`
* Move the dist to your project directory. - `mv jasmine/dist/jasmine-standalone-{#.#.#}.zip my-project/jasmine`
* Change directory. - `cd my-project/jasmine`
* Unzip the dist. - `unzip jasmine-standalone-{#.#.#}.zip`
Add the following to your HTML file:
```html
<link rel="shortcut icon" type="image/png" href="lib/jasmine-{#.#.#}/jasmine_favicon.png">
<link rel="stylesheet" href="lib/jasmine-{#.#.#}/jasmine.css">
<script src="lib/jasmine-{#.#.#}/jasmine.js"></script>
<script src="lib/jasmine-{#.#.#}/jasmine-html.js"></script>
<script src="lib/jasmine-{#.#.#}/boot0.js"></script>
<!-- optional: include a file here that configures the Jasmine env -->
<script src="lib/jasmine-{#.#.#}/boot1.js"></script>
```
## Supported environments ## Supported environments
Jasmine tests itself across popular browsers (Safari, Chrome, Firefox, and Jasmine tests itself across popular browsers (Safari, Chrome, Firefox, and
Microsoft Edge) as well as nodejs. Microsoft Edge) as well as Node.
| Environment | Supported versions | | Environment | Supported versions |
|-------------------|--------------------| |-------------------|--------------------|