From 6c2108ebbe8402baa8216d4db92e0444875415d1 Mon Sep 17 00:00:00 2001 From: gennyble Date: Mon, 9 Oct 2023 20:28:52 -0500 Subject: add note about tolerance tuning --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa69edc..ef9ce84 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ | - | - | | ![a small dog laying on a concrete floor in an industrial building](https://nyble.dev/colorsquash/astro.jpg) | ![the same image in 256 color. there are some visual differences, but the two images look very similar](https://nyble.dev/colorsquash/astro_squash.gif) | -colorsquash is a colour quantization[^1] crate and algorithm. +> [!IMPORTANT] +> This crate isn't *quite* ready yet. There's some tuning and research to be done while selecting the palette. To get the best results you'll likely have to do some trial and error with the tolerance for your specific application. + +colorsquash is a colour quantization[^1] crate and algorithm. + At it's core, it sorts the colors of an image by how frequently they appear, greatest to least. It then goes through those colours and takes the top N colours that are sufficiently different. -- cgit 1.4.1-3-g733a5