Rockingcool/ccat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Updated README

Browse Source
This commit is contained in:
Aadhavan Srinivasan
2024-08-14 12:20:20 -05:00
parent 79cd6dab8d
commit 925ef4df4b
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -24,8 +24,21 @@ If you have the `go` command installed, run `make` after cloning the repository.
### Getting Started ### 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. 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.
As written above, if provided a file with extension `.example`, the program will look for the config file named `example.conf`. If such a file doesn't exist, the file is printed out without any highlighting.
---
### Config Files
The config files are written in YAML, and have the following syntax:
`"<regex>": COLOR"`
Note that the regex must be enclosed in double quotes, and the color must be capitalized.
--- ---
### TODO: ### TODO:
- Allow user to define colors at runtime by reading RGB values from a config file. - Allow user to define colors at runtime by reading RGB values from a config file.
- Allow users to provide a config file in the command-line, overriding the extension-based config file.
- Provide releases. - Provide releases.