Skip to content

Commit 58f577e

Browse files
committed
fixup! Update README, and move to using reST. Fixes html5lib#5, html5lib#22.
1 parent 576be46 commit 58f577e

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.rst

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,38 @@ html5lib
22
========
33

44
html5lib is a pure-python library for parsing HTML. It is designed to
5-
conform to the HTML specification, which has formalized the error
6-
handling algorithms of legacy web browsers, and is now implemented by
7-
all major web browsers.
5+
conform to the HTML specification, as is implemented by all major web
6+
browsers.
87

98

109
Requirements
1110
------------
1211

13-
Python 2.6 and above (including 3) are supported. Implementations
14-
known to work are CPython (as the reference implementation) and
15-
PyPy. Jython is known *not* to work due to various bugs in its
16-
implementation of the language. Others such as IronPython may or may
17-
not work; if you wish to try, you are strongly recommended to run the
18-
testsuite and report back!
12+
Python 2.6 and above as well as Python 3.0 and above are
13+
supported. Implementations known to work are CPython (as the reference
14+
implementation) and PyPy. Jython is known *not* to work due to various
15+
bugs in its implementation of the language. Others such as IronPython
16+
may or may not work; if you wish to try, you are strongly encouraged
17+
to run the testsuite and report back!
1918

2019
The only required library dependency is ``six``, this can be found
2120
packaged in PyPi.
2221

2322
Optionally:
2423

2524
- ``datrie`` can be used to improve parsing performance (though in
26-
almost all cases the improvement is trivial);
25+
almost all cases the improvement is marginal);
2726

2827
- ``lxml`` is supported as a tree format (for both building and
2928
walking) under CPython (but *not* PyPy where it is known to cause
3029
segfaults);
3130

3231
- ``genshi`` has a treewalker (but not builder); and
3332

34-
- ``chardet`` (note currently this is only packaged on PyPi for
33+
- ``chardet`` can be used as a fallback when character encoding cannot
34+
be determined (note currently this is only packaged on PyPi for
3535
Python 2, though several package managers include unofficial ports
36-
to Python 3) can be used as a fallback when character encoding
37-
cannot be determined.
36+
to Python 3).
3837

3938

4039
Installation
@@ -72,15 +71,15 @@ Please report any bugs on the `issue tracker
7271
Tests
7372
-----
7473

75-
These are nowadays contained in the html5lib-tests repository and
76-
included as a submodule, thus for git checkouts they must be
77-
initialized (for release tarballs this is unneeded)::
74+
These are contained in the html5lib-tests repository and included as a
75+
submodule, thus for git checkouts they must be initialized (for
76+
release tarballs this is unneeded)::
7877

7978
$ git submodule init
8079
$ git submodule update
8180

82-
And then they can be run once ``nose`` has been installed with
83-
``nosetests``. All should pass.
81+
And then they can be run, with ``nose`` installed, using the
82+
``nosetests`` command in the root directory. All should pass.
8483

8584

8685
Contributing

0 commit comments

Comments
 (0)