aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEuAndreh <eu@euandre.org>2021-03-07 19:56:46 -0300
committerEuAndreh <eu@euandre.org>2021-03-07 19:56:46 -0300
commit3c31f20fa15428b7d3a58a2a26977c171a046c87 (patch)
tree70e4edc35165213cda85576cd224c3bff042587d /README.md
parentmanifest.scm: Remove gettext package (diff)
downloadremembering-3c31f20fa15428b7d3a58a2a26977c171a046c87.tar.gz
remembering-3c31f20fa15428b7d3a58a2a26977c171a046c87.tar.xz
README.md: re-write contributing with more spaced examples
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
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