X-Git-Url: http://git.refcnt.org/?p=colorize.git;a=blobdiff_plain;f=README;h=20c1f0077fe65473e8573fdddf638a26bed7292e;hp=12656376935b5867e49b79c1176fb1db233d5ff6;hb=HEAD;hpb=a4a170bb3a39da6e246708d53435e902cfb1c189

diff --git a/README b/README
index 1265637..20c1f00 100644
--- a/README
+++ b/README
@@ -20,6 +20,7 @@ Requirements
 gcc
 make
 perl
+valgrind (optional)
 
 Build instructions
 ------------------
@@ -27,15 +28,56 @@ 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'.
+
+Customizing instructions
+------------------------
+The default character ('/') which separates the foreground
+from the background color may be redefined:
+
+`make FLAGS=-DCOLOR_SEP_CHAR_COLON' -> defines as ':'
+`make FLAGS=-DCOLOR_SEP_CHAR_SLASH' -> defines as '/'
+
+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.
+
+Configuration File
+------------------
+A user configuration file may be populated with options and
+according values.  See man page source file `colorize.1' for
+details.
 
 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.