Hopiu/linkchecker
1
0
Fork 0
mirror of https://github.com/Hopiu/linkchecker.git synced 2026-05-05 05:04:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #582 from cjmayo/readme

Browse source 
Reference manuals and mention GitHub Packages in README
This commit is contained in:
Chris Mayo 2021-12-06 19:30:11 +00:00 committed by GitHub
commit d1ad23016c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -42,12 +42,18 @@ in the source code archive.
Usage
------
Execute ``linkchecker https://www.example.com``.
For other options see ``linkchecker --help``.
For other options see ``linkchecker --help``, and for more information the
manual pages `linkchecker(1)`_ and `linkcheckerrc(5)`_.
.. _linkchecker(1): https://linkchecker.github.io/linkchecker/man/linkchecker.html
.. _linkcheckerrc(5): https://linkchecker.github.io/linkchecker/man/linkcheckerrc.html
Docker usage
-------------
If you do not want to install any additional libraries/dependencies you can use the Docker image.
If you do not want to install any additional libraries/dependencies you can use
the Docker image which is published on GitHub Packages.
Example for external web site check::