Skip to content

Commit 750b10b

Browse files
committed
Expand README and add update instructions
1 parent 5c16a7f commit 750b10b

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
1-
html5lib-tests
2-
==============
1+
# html5lib-tests
32

4-
This test data was taken from:
3+
This directory contains a third-party test suite used for testing the WordPress HTML API.
54

6-
https://github.com/html5lib/html5lib-tests
5+
`html5lib-tests` can be found on GitHub at [html5lib/html5lib-tests](https://github.com/html5lib/html5lib-tests).
76

8-
The sha was `a9f44960a9fedf265093d22b2aa3c7ca123727b9`.
7+
The necessary files have been copied to this directory:
98

10-
## Instructions
9+
- `AUTHORS.rst`
10+
- `LICENSE`
11+
- `README.md`
12+
- `tree-construction/README.md`
13+
- `tree-construction/*.dat`
1114

12-
@todo add instructions here.
15+
The version of these files was taken from the git commit with
16+
SHA [`a9f44960a9fedf265093d22b2aa3c7ca123727b9`](https://github.com/html5lib/html5lib-tests/commit/a9f44960a9fedf265093d22b2aa3c7ca123727b9).
17+
18+
## Updating
19+
20+
If there have been changes to the html5lib-tests repository, this test suite can be updated. In
21+
order to update:
22+
23+
1. Check out the latest version of git repository mentioned above.
24+
1. Copy the files listed above into this directory.
25+
1. Update the SHA mentioned in this README file with the new html5lib-tests SHA.

0 commit comments

Comments
 (0)