Merge pull request #163 from linkchecker/anarcat-patch-1

add note about missing Windows support
This commit is contained in:
anarcat 2018-06-22 10:00:53 -04:00 committed by GitHub
commit b024aa8bbe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -27,11 +27,15 @@ Features
Installation
-------------
See doc/install.txt in the source code archive.
Python 2.7.2 or later is needed. It doesn't work with Python 3 yet, see `#40 <https://github.com/linkcheck/linkchecker/pull/40>`_ for details.
``pip install linkchecker`` should NOT be used for now, as it will install the old version of linkchecker. See `#4 <https://github.com/linkcheck/linkchecker/pull/4>`_.
Windows builds are seriously lagging behind the Linux releases, see `#53 <https://github.com/linkchecker/linkchecker/issues/53>`_ for details. For now, the only two options are to install from source or use `Docker for Windows <https://www.docker.com/docker-windows>`_.
Usage
------
Execute ``linkchecker http://www.example.com``.