xrefcheck icon indicating copy to clipboard operation
xrefcheck copied to clipboard
verified publisher icon serokell

Document usage

Open balsoft opened this issue 5 years ago • 0 comments

Clarification and motivation

If we want xrefcheck to ever become popular, we need to write complete yet concise documentation on usage of the tool, including:

  • [ ] Basic setup for various CIs, common usage patterns;
    • [ ] GitHub
    • [ ] GitLab
    • [ ] Generic docker image
    • [ ] Generic native executable
  • [ ] CLI options;
  • [ ] Configuration file;
  • [ ] Known caveats.

Acceptance criteria

My mom can understand how to use the tool after reading the docs.

balsoft avatar Jun 23 '20 21:06 balsoft