Merge branch 'config_file'

[colorize.git] / README

diff --git a/README b/README
index 5890e6d1856ee72877a4c91a0271d634502a7295..20c1f0077fe65473e8573fdddf638a26bed7292e 100644 (file)
--- a/README
+++ b/README
@@ -28,10 +28,20 @@ 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
 ----------------------
@@ -46,6 +56,12 @@ 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.