diff options
author | Steven Schubiger <stsc@refcnt.org> | 2013-12-10 22:26:08 +0100 |
---|---|---|
committer | Steven Schubiger <stsc@refcnt.org> | 2013-12-10 22:26:08 +0100 |
commit | a4a170bb3a39da6e246708d53435e902cfb1c189 (patch) | |
tree | b4fdd47d351a7c466574677f2b1e3c8de11979d7 /README | |
parent | 9a1c3657772d04b82aee08b30af9c53e2f2c7a3e (diff) | |
download | colorize-a4a170bb3a39da6e246708d53435e902cfb1c189.tar.gz colorize-a4a170bb3a39da6e246708d53435e902cfb1c189.tar.bz2 |
First draft of README
Diffstat (limited to 'README')
-rw-r--r-- | README | 45 |
1 files changed, 45 insertions, 0 deletions
@@ -0,0 +1,45 @@ +colorize +======== + +Description +----------- +Colorize aims at being a small, independent and handy command-line +text colorizing tool. It emits ANSI escape sequences in order to +color lines of text; also, sequences emitted by colorize or foreign +programs may be cleared. + +The main code is written in C (c89 mostly), whereas the test script +consists of Perl code. + +Colorize is known to build and test successfully on Linux and +Net/Open/MirBSD. Other platforms are untested, so be prepared for +it to eventually not work as expected there. + +Requirements +------------ +gcc +make +perl + +Build instructions +------------------ +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. + +Finally, remove it through `make clean'. + +Documentation +------------- +See man page source file: colorize.1. + +Afterword +--------- +Let me know, if you have ideas, bug reports, patches, etc. + +Author +------ +Steven Schubiger <stsc@refcnt.org> |