aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Steven Schubiger <stsc@refcnt.org>2016-10-04 17:32:46 +0200
committerGravatar Steven Schubiger <stsc@refcnt.org>2016-10-04 17:32:46 +0200
commitb046a247ae0220a415b085930992dae046d4439f (patch)
treefe60a23910ca3a3ef7ac15efff30ecfbf045171a
parente644ee656f5a2ec2dabe74dc14e432b336082cbf (diff)
downloadcolorize-b046a247ae0220a415b085930992dae046d4439f.tar.gz
colorize-b046a247ae0220a415b085930992dae046d4439f.tar.bz2
Mention running tests through valgrind in README
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index afd40b9..5890e6d 100644
--- 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.