diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0db61d0 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +Colorsquash is a colour quantization[^1] crate and algorithm. +At it's core, it sorts the unique colours that appear in an image +and selects the most frequent that are sufficiently different. + +To put it more clearly: +The most frequent colour is always selected and placed into the palette. +If the second most frequent colour is *different enough*, it will be selected +as well. If it's not, it is skipped and the third one is tried. This continues +until it selects the necessary amount of colours. + +[^1] (wikipedia: color quantization)[https://en.wikipedia.org/wiki/Color_quantization] + +### squash +A CLI tool to quantize colours. Accepts a path to a PNG; exports an indexed PNG. \ No newline at end of file |