diff options
| author | EuAndreh <eu@euandre.org> | 2021-03-07 19:24:08 -0300 |
|---|---|---|
| committer | EuAndreh <eu@euandre.org> | 2021-03-07 19:24:08 -0300 |
| commit | fc28caa1f658928c79ba095afebe0294394a5403 (patch) | |
| tree | 80c990a4217e0f509dfbb105a104c5eb6b5a9d77 | |
| parent | src/remembering.c: Add tests for negative and floating-point numbers in the p... (diff) | |
| download | remembering-fc28caa1f658928c79ba095afebe0294394a5403.tar.gz remembering-fc28caa1f658928c79ba095afebe0294394a5403.tar.xz | |
README.md: Add Contributing section, documenting extra dependencies
| -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/ |