From 5e0bbbec4f64126ec19bb50e484f1379561bb02f Mon Sep 17 00:00:00 2001 From: Rockingcool Date: Wed, 14 Aug 2024 12:15:19 -0500 Subject: [PATCH] Added README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..68f07f0 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +## ccat + +ccat is a file printing tool (like 'cat') which uses Regular Expressions to highlight syntax highlighting. + +--- + +### Features +- Support for 11 colors: Red, Blue, Green, Magenta, Cyan, Black, White, Yellow, Gray, Orange and Dark Blue. +- Adding more colors involves adding a line of code, then recompiling. +- Regex-color mappings are stored in configuration files. +- Uses the file extension to determine which configuration file to use. +- Highly extensible - to add a config file for an specific file type, name the file `.conf`. +- Support for printing line numbers with the `-n` flag. +- Statically linked Go binary - no runtime dependencies, config files are distributed along with the binary. +- Cross-platform + +--- + +### Installing +If you have the `go` command installed, run `make` after cloning the repository. + +### Getting Started +The config files are embedded within the binary. They will automatically be installed to the correct location (`%APPDATA/ccat` on Windows, `~/.config/ccat` on UNIX) when the program is first run. +TODO: +- Allow user to define colors at runtime by reading RGB values from a config file. +- Provide releases.