aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..44bf09a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Color Blind Palettes
+
+A small tool to render an HTML overview of color-blind-friendly palettes (for plots, etc.).
+
+See https://kingdread.de/palettes.html for a rendered version.
+
+I did not come up with those palettes, I just wanted a nicer way to use them (than to manually copy them from PDF style guides).
+
+## Usage
+
+To generate the `palettes.html`:
+
+```
+poetry install
+poetry run cbp palettes.toml
+```
+
+## See also
+
+* PyPI: [`tol-colors`](https://pypi.org/project/tol-colors/)
+
+## License
+
+```
+Copyright © 2025 Daniel Schadt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```