diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -34,6 +34,23 @@ make [sudo] make install ``` +The requirements are a C99 compiler on a POSIX.1-2008 +environment (`_POSIX_C_SOURCE 200809L`). + ## Documentation Documentation available via installed manpages or online: [`remembering.1`](remembering.1.html) and [`remembering.5`](remembering.5.html). + +## Contributing + +Extra tools used for development are: +- [fallible] and [Valgrind] for memory testing; +- [ShellCheck] for validating scripts; +- [pandoc], troff and Perl for generating the documentation HTML and website. + +Run `make dev-check` for extra development-only checks such as memory tests, and `make public` for generating the documentation HTML and website. + +[fallible]: https://fallible.euandreh.xyz +[Valgrind]: https://valgrind.org +[ShellCheck]: https://www.shellcheck.net/ +[pandoc]: https://pandoc.org/ |