gcc
make
perl
+valgrind (optional)
Build instructions
------------------
Once completed, run the tests with `make check'.
-Then you should most likely have a working binary. There are
-currently no make targets to install it as such.
+Then you should most likely have a working binary.
-Finally, remove it through `make clean'.
+Next, install it with `make install' (may require elevated
+user permissions).
+
+Finally, clean up the working directory 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.