docs: add initial README

2026-01-31 18:40:57 +03:00
parent e35c4043bf
commit adc81e0a0a
1 changed files with 35 additions and 0 deletions
@@ -0,0 +1,35 @@
+# ccolors
+
+Small CLI tool to extract dominant color palettes from images.
+
+## Features
+
+- JPEG / PNG support
+- Terminal color preview
+- HEX output
+- JSON export
+- No external dependencies
+
+## Build
+
+### Linux / macOS
+```bash
+mkdir build
+cd build
+cmake ..
+make```
+
+## Usage
+```bash
+./ccolors image.jpg
+```
+
+## Output
+- Prints color swatches + hex
+- Writes palette.json
+
+## Dependencies
+- stb_image.h (included)
+
+## License
+MIT