Amend files to satisfy lintian

[colorize.git] / README

diff --git a/README b/README
index 12656376935b5867e49b79c1176fb1db233d5ff6..5890e6d1856ee72877a4c91a0271d634502a7295 100644 (file)
--- a/README
+++ b/README
@@ -20,6 +20,7 @@ Requirements
 gcc
 make
 perl
+valgrind (optional)
 
 Build instructions
 ------------------
@@ -32,10 +33,35 @@ currently no make targets to install it as such.
 
 Finally, remove it through `make clean'.
 
+Debugging instructions
+----------------------
+For the sake of completeness, colorize can be also built with
+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.
 
+Usage example
+-------------
+In ~/.bashrc:
+
+| ls_color() {
+|     ls "$@" | colorize green -
+| }
+| alias ls=ls_color
+
+This excerpt defines an alias which will set the color being
+printed for literal ls invocations to green.
+
 Afterword
 ---------
 Let me know, if you have ideas, bug reports, patches, etc.