X-Git-Url: http://git.refcnt.org/?p=colorize.git;a=blobdiff_plain;f=README;h=a6e8f0f18c259ba1b40b880b88e0adc281a51e4d;hp=afd40b9209282b0b3c96c0c6c52599f0799c8b32;hb=c5aee0b6ea9709789396f90ad115dd16ac970b0b;hpb=02ff24b4d080945fa5b5eecd8b57780b0035ecea diff --git a/README b/README index afd40b9..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,6 +42,12 @@ 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.