X-Git-Url: http://git.refcnt.org/?p=colorize.git;a=blobdiff_plain;f=README;h=a6e8f0f18c259ba1b40b880b88e0adc281a51e4d;hp=a25ddedcddc7bfb28743dc7f94b836925c3d0b6a;hb=9e27da967973e089efe2f71f6279ebc4fe284c1a;hpb=dbbbe0626872bd88a0262a8545b81a1b5eeceaa4

diff --git a/README b/README
index a25dded..a6e8f0f 100644
--- a/README
+++ b/README
@@ -20,6 +20,7 @@ Requirements
 gcc
 make
 perl
+valgrind (optional)
 
 Build instructions
 ------------------
@@ -27,10 +28,12 @@ Issue `make' to build colorize.
 
 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
 ----------------------
@@ -39,10 +42,28 @@ 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.