From 3c31f20fa15428b7d3a58a2a26977c171a046c87 Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Sun, 7 Mar 2021 19:56:46 -0300 Subject: README.md: re-write contributing with more spaced examples --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b659bcd..2ca157f 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,17 @@ Extra tools used for development are: - [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. +For extra development-only checks such as memory tests, run: + +```shell +$ make dev-check +``` + +and for generating the documentation HTML and website, run: + +```shell +$ make public +``` [fallible]: https://fallible.euandreh.xyz [Valgrind]: https://valgrind.org -- cgit v1.2.3