Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Simplify README #18970

Merged
merged 3 commits into from Oct 11, 2019
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -1,26 +1,14 @@
# Resources

This directory contains utilities intended for use by tests of the web
This conversation was marked as resolved by zcorpan

This comment has been minimized.

Copy link
@zcorpan

zcorpan Oct 4, 2019

Member
Suggested change
This directory contains utilities intended for use by tests of the web
This directory contains utilities intended for use by tests.
platform. It does not contain tests for web platform features.
This conversation was marked as resolved by zcorpan
Comment on lines +3 to +4

This comment has been minimized.

Copy link
@gsnedders

gsnedders Oct 4, 2019

Contributor

I think "of the web platform" and "for web platform features" seems redundant.

This conversation was marked as resolved by zcorpan

This comment has been minimized.

Copy link
@zcorpan

zcorpan Oct 4, 2019

Member
Suggested change
platform. It does not contain tests for web platform features.
It does not contain tests.

## `testharness.js`

`testharness.js` is a framework for writing low-level tests of
browser functionality in javascript. It provides a convenient API for
making assertions and is intended to work for both simple synchronous
tests, and tests of asynchronous behaviour.

### Getting started

To use `testharness.js` you must include two scripts, in the order given:

``` html
<script src=/resources/testharness.js></script>
<script src=/resources/testharnessreport.js></script>
```

### Full documentation

For detailed API documentation please visit [https://web-platform-tests.org/writing-tests/testharness-api.html](https://web-platform-tests.org/writing-tests/testharness-api.html).

### Tutorials

You can also read a tutorial on
[Using testharness.js](http://darobin.github.com/test-harness-tutorial/docs/using-testharness.html).
Complete documentation is available in the `docs/` directory of this repository
and on the web at http://web-platform-tests.org/writing-tests.
This conversation was marked as resolved by zcorpan

This comment has been minimized.

Copy link
@zcorpan

zcorpan Oct 4, 2019

Member
Suggested change
and on the web at http://web-platform-tests.org/writing-tests.
and on the web at https://web-platform-tests.org/writing-tests/.
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.