summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkj_sh6042026-03-15 13:00:31 -0400
committerkj_sh6042026-03-15 13:00:31 -0400
commit5fee19838c90d3d75f6a8c7b0cbb4da8b6762ff5 (patch)
tree375f37834c5d59ce58ca55e3ec0218ea119d5de4 /README.md
parent3960458765142f7e1475ed4c662dffe3e73a0255 (diff)
refactor: update docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md73
1 files changed, 43 insertions, 30 deletions
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
11 11
12## features 12## features
13 13
14- Agave-style scheme generator with: 14- agave-style scheme generator modes:
15 - Triads 15 - triads
16 - Complements 16 - complements
17 - Split Complements 17 - split complements
18 - Tetrads 18 - tetrads
19 - Analogous 19 - analogous
20 - Monochromatic 20 - monochromatic
21- large scheme preview cards showing hex, rgb, and hsv 21- compact top swatch cards with centered overlay metadata:
22- lighten, darken, saturate, desaturate quick actions 22 - hex
23- color history navigation (back/forward) 23 - rgb
24- random color generation 24 - hsv
25- palette browser with built-in web-safe, tango, and visibone-style sets 25- dynamic overlay text contrast (light/dark text based on background luminance)
26- favorites panel with add/remove/clear 26- toolbar actions: back, forward, random, lighten, darken, saturate, desaturate, paste
27- favorites export to GIMP `.gpl` (`~/.config/kjagave-favorites.gpl`) 27- click a top swatch to promote it to the active base color
28- clipboard copy/paste for hex colors 28- right-click on top swatches and palette swatches to copy:
29- screen picker support on X11 (`xcolor` or `grabc`) 29 - hex
30 - hsv
31 - rgb
32- 12 built-in palettes:
33 - Web-safe (legacy)
34 - Material Design
35 - Tailwind CSS
36 - Flat UI
37 - Pastel
38 - Nord
39 - Dracula
40 - Solarized
41 - Gruvbox
42 - One Dark
43 - Monokai
44 - KiJiSH Dark Pastel Terminal
45- favorites panel with add/remove/rename/clear
46- clipboard copy/paste support
47- screen picker support on X11 via `xcolor` or `grabc`
48- persisted state in `~/.config/kjagave.json` (last color, scheme, palette, favorites)
30 49
31## requirements 50## requirements
32 51
33- go 1.21 or higher 52- go 1.21 or higher
34- gtk3 development libraries 53- gtk3 development libraries
35- `gotk3` go bindings 54- `gotk3` Go bindings
36- `xcolor` 55- optional for pick-from-screen: `xcolor` or `grabc`
37 56
38## installation 57## installation
39 58
@@ -44,15 +63,11 @@ cd archlinux
44makepkg -si 63makepkg -si
45``` 64```
46 65
47see `archlinux/README.md` for more details.
48
49### manual build 66### manual build
50 67
51```sh 68```sh
52cd src 69cd src
53go mod download 70go build -o kjagave .
54go mod download github.com/gotk3/gotk3
55go build -o kjagave main.go
56``` 71```
57 72
58## running 73## running
@@ -63,10 +78,8 @@ go build -o kjagave main.go
63 78
64## usage 79## usage
65 80
661. pick a base color with the color button, hex entry, palette list, or screen picker 811. pick a base color with the color button, hex entry, palette swatches, or screen picker
672. choose a scheme type from the combo box 822. choose a scheme type
683. click any preview card to promote that scheme color to the active base color 833. click a preview swatch to make it the active base color
694. use toolbar actions (`Back`, `Forward`, `Random`, `Lighten`, `Darken`, `Saturate`, `Desaturate`, `Paste`) to iterate quickly 844. right-click a swatch to copy hex/hsv/rgb
705. add colors to favorites with `+`, remove with `-`, and export favorites with `Export GPL` 855. use favorites controls (`+`, `-`, rename, clear) to manage saved colors \ No newline at end of file
71
72state and favorites are stored in `~/.config/kjagave.json`.