Mention running tests through valgrind in README

[colorize.git] / README

diff --git a/README b/README
index afd40b9209282b0b3c96c0c6c52599f0799c8b32..5890e6d1856ee72877a4c91a0271d634502a7295 100644 (file)
--- a/README
+++ b/README
@@ -20,6 +20,7 @@ Requirements
 gcc
 make
 perl
+valgrind (optional)
 
 Build instructions
 ------------------
@@ -39,6 +40,12 @@ debugging output by issuing `make FLAGS=-DDEBUG'.  The intention
 is to provide some memory allocation diagnostics (and might be
 extended in future).  Usually, a debugging build is not required.
 
+Furthermore, tests can be run through valgrind by issuing, for
+example, `make check_valgrind 2>&1 | tee valgrind.out'.  The
+file provided here for the `tee' invocation will be populated
+with the captured output from both standard output and error
+stream.
+
 Documentation
 -------------
 See man page source file: colorize.1.