From 0ad7b21c0544b09198ddfe182b94b45c4b8b94c6 Mon Sep 17 00:00:00 2001 From: whut Date: Thu, 23 Jun 2022 23:31:22 -0500 Subject: [PATCH] hey let's add an example so people can see how to use the damn thing --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1d2db28..864c54c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ Color arguments are in the form of "hue,chroma,luminance" for background and "hu The script will do its best to make sure everything is readable. With Base16, for instance, it tries to keep a contrast ratio of 7:1 between the foreground and background colors, while trying to stay above 3:1 for foreground and highlight, the last 8 colors (the "hues") and highlight, and the "dark" foreground and background. Usually it does a good job. But with the way it handles contrast, things get unreadable with some values (see "On luminance options"). +## Example + +``` +./acid16.py 0.6,0.25,0.005 0.6,0.5 0.0,0.0 +``` +This creates a color scheme with: +- A dark bluish background (hue 0.6, chroma 0.25, luminance 0.005) +- An accent color with that same hue but more saturation (hue 0.6, chroma 0.5) +- Some shade of gray for the foreground color (hue 0.0, chroma 0.0). In this case it'll be a light gray since the background is dark. + ## Prerequisites - Python 3