diff options
Diffstat (limited to '')
-rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -26,6 +26,40 @@ make [sudo] make install ``` +The requirements are Perl with dependencies: +- [p5-Git-Raw]: Perl bindings to [libgit2]; +- [Mustache::Simple]: template library for generating output files; +- [CommonMark][cm-p]: [CommonMark][cm-spec] renderer. + +[p5-Git-Raw]: https://github.com/jacquesg/p5-Git-Raw/ +[libgit2]: https://libgit2.org/ +[Mustache::Simple]: https://metacpan.org/pod/Mustache::Simple +[cm-p]: https://metacpan.org/pod/CommonMark +[cm-spec]: https://commonmark.org/ + ## Documentation Documentation available via installed manpages, also available online: [`gistatic.1`](gistatic.1.html). + +## Contributing + +Extra tools used for development are: +- [perltidy] for code formatting; +- [ShellCheck] for validating scripts; +- [pandoc] for generating the documentation HTML and website. + +[perltidy]: https://metacpan.org/pod/perltidy +[ShellCheck]: https://www.shellcheck.net/ +[pandoc]: https://pandoc.org/ + +For running the extra development-only checks, run: + +```shell +$ make dev-check +``` + +and for generating the documentation HTML and website, run: + +```shell +$ make public +``` |