From ef712cc8c545044b469fe843c5a3fc190fab4e42 Mon Sep 17 00:00:00 2001 From: kj_sh604 Date: Sun, 15 Mar 2026 11:40:51 -0400 Subject: refactor: boilerplate re-write --- README.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 21e3779..ff0aacf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # kjagave -a color picker inspired by agave, but only with the features I actually used +a GTK3 color scheme generator inspired by classic Agave, rewritten in Go recent screenshot
@@ -11,12 +11,22 @@ a color picker inspired by agave, but only with the features I actually used ## features -- visual color picker with rgb/hsv sliders -- **pick colors from anywhere on screen (only on x11 because I'm lazy)** -- alpha channel support -- save and manage favorite colors -- copy hex color codes to clipboard -- clean, minimal interface +- Agave-style scheme generator with: + - Triads + - Complements + - Split Complements + - Tetrads + - Analogous + - Monochromatic +- large scheme preview cards showing hex, rgb, and hsv +- lighten, darken, saturate, desaturate quick actions +- color history navigation (back/forward) +- random color generation +- palette browser with built-in web-safe, tango, and visibone-style sets +- favorites panel with add/remove/clear +- favorites export to GIMP `.gpl` (`~/.config/kjagave-favorites.gpl`) +- clipboard copy/paste for hex colors +- screen picker support on X11 (`xcolor` or `grabc`) ## requirements @@ -53,12 +63,10 @@ go build -o kjagave main.go ## usage -1. use the color picker button to open the full color selection dialog -2. **click "Pick from Screen" to grab a color from anywhere on your screen** - your cursor will change to a crosshair, click on any pixel to select its color -3. click "Copy to Clipboard" to copy the hex color code -4. click "Save..." to save the current color to your favorites list -5. expand "Saved Colors" to view and manage your saved colors -6. select a saved color to load it in the picker -7. click "Delete" to remove a selected saved color +1. pick a base color with the color button, hex entry, palette list, or screen picker +2. choose a scheme type from the combo box +3. click any preview card to promote that scheme color to the active base color +4. use toolbar actions (`Back`, `Forward`, `Random`, `Lighten`, `Darken`, `Saturate`, `Desaturate`, `Paste`) to iterate quickly +5. add colors to favorites with `+`, remove with `-`, and export favorites with `Export GPL` -saved colors are stored in `~/.config/kjagave.json` as json. +state and favorites are stored in `~/.config/kjagave.json`. -- cgit v1.2.3 From 5fee19838c90d3d75f6a8c7b0cbb4da8b6762ff5 Mon Sep 17 00:00:00 2001 From: kj_sh604 Date: Sun, 15 Mar 2026 13:00:31 -0400 Subject: refactor: update docs --- README.md | 73 +++++++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 43 insertions(+), 30 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ff0aacf..5c33777 100644 --- a/README.md +++ b/README.md @@ -11,29 +11,48 @@ a GTK3 color scheme generator inspired by classic Agave, rewritten in Go ## features -- Agave-style scheme generator with: - - Triads - - Complements - - Split Complements - - Tetrads - - Analogous - - Monochromatic -- large scheme preview cards showing hex, rgb, and hsv -- lighten, darken, saturate, desaturate quick actions -- color history navigation (back/forward) -- random color generation -- palette browser with built-in web-safe, tango, and visibone-style sets -- favorites panel with add/remove/clear -- favorites export to GIMP `.gpl` (`~/.config/kjagave-favorites.gpl`) -- clipboard copy/paste for hex colors -- screen picker support on X11 (`xcolor` or `grabc`) +- agave-style scheme generator modes: + - triads + - complements + - split complements + - tetrads + - analogous + - monochromatic +- compact top swatch cards with centered overlay metadata: + - hex + - rgb + - hsv +- dynamic overlay text contrast (light/dark text based on background luminance) +- toolbar actions: back, forward, random, lighten, darken, saturate, desaturate, paste +- click a top swatch to promote it to the active base color +- right-click on top swatches and palette swatches to copy: + - hex + - hsv + - rgb +- 12 built-in palettes: + - Web-safe (legacy) + - Material Design + - Tailwind CSS + - Flat UI + - Pastel + - Nord + - Dracula + - Solarized + - Gruvbox + - One Dark + - Monokai + - KiJiSH Dark Pastel Terminal +- favorites panel with add/remove/rename/clear +- clipboard copy/paste support +- screen picker support on X11 via `xcolor` or `grabc` +- persisted state in `~/.config/kjagave.json` (last color, scheme, palette, favorites) ## requirements - go 1.21 or higher - gtk3 development libraries -- `gotk3` go bindings -- `xcolor` +- `gotk3` Go bindings +- optional for pick-from-screen: `xcolor` or `grabc` ## installation @@ -44,15 +63,11 @@ cd archlinux makepkg -si ``` -see `archlinux/README.md` for more details. - ### manual build ```sh cd src -go mod download -go mod download github.com/gotk3/gotk3 -go build -o kjagave main.go +go build -o kjagave . ``` ## running @@ -63,10 +78,8 @@ go build -o kjagave main.go ## usage -1. pick a base color with the color button, hex entry, palette list, or screen picker -2. choose a scheme type from the combo box -3. click any preview card to promote that scheme color to the active base color -4. use toolbar actions (`Back`, `Forward`, `Random`, `Lighten`, `Darken`, `Saturate`, `Desaturate`, `Paste`) to iterate quickly -5. add colors to favorites with `+`, remove with `-`, and export favorites with `Export GPL` - -state and favorites are stored in `~/.config/kjagave.json`. +1. pick a base color with the color button, hex entry, palette swatches, or screen picker +2. choose a scheme type +3. click a preview swatch to make it the active base color +4. right-click a swatch to copy hex/hsv/rgb +5. use favorites controls (`+`, `-`, rename, clear) to manage saved colors \ No newline at end of file -- cgit v1.2.3