mirror of https://github.com/serokell/xrefcheck.git synced 2024-09-11 13:37:36 +03:00

Ivan Gromakovskii 482e9b2684

Problem: CI uses some temporary workarounds, one may wonder whether
they are necessary and not get an answer.

Solution: write about it in README.

2019-12-05 00:00:41 +03:00

Crossref-verifier

Tool for verifying local and external references in repository documentation.

For now, support for markdown files only is provided.

Build instructions ↑

Run stack install to build everything and install executable.

CI uses nix-build to build the project. It is based on the haskell.nix project. You can do that too if you want.

There is a bug which causes us to put some redundancy into Nix files:

nix/sources.json lists all such dependencies that we obtain using git. It specifies concrete git revisions and SHA256 checksums.
default.nix lists all such dependencies as well, but without revisions.

As a consequence, you may have to update these files when you update stack.yaml. You can use niv update to update nix/sources.json.

To find all broken links in repository run

crossref-verify --root <repository>

For description of other options

crossref-verify --help

We use YouTrack as our issue tracker. You can login using your GitHub account to leave a comment or create a new issue.

Please see CONTRIBUTING.md for more information.

Crossref-verifier is maintained by Serokell.

We love open source software. See which services we provide and drop us a line if you are interested.