summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md67
1 files changed, 44 insertions, 23 deletions
diff --git a/README.md b/README.md
index 21e3779..5c33777 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
2 2
3# kjagave 3# kjagave
4 4
5a color picker inspired by agave, but only with the features I actually used 5a GTK3 color scheme generator inspired by classic Agave, rewritten in Go
6 6
7<img width="554" height="467" alt="recent screenshot" src="https://github.com/user-attachments/assets/efbea3f0-9d1f-45b1-865b-bb82a3ddc443" /><br> 7<img width="554" height="467" alt="recent screenshot" src="https://github.com/user-attachments/assets/efbea3f0-9d1f-45b1-865b-bb82a3ddc443" /><br>
8 8
@@ -11,19 +11,48 @@ a color picker inspired by agave, but only with the features I actually used
11 11
12## features 12## features
13 13
14- visual color picker with rgb/hsv sliders 14- agave-style scheme generator modes:
15- **pick colors from anywhere on screen (only on x11 because I'm lazy)** 15 - triads
16- alpha channel support 16 - complements
17- save and manage favorite colors 17 - split complements
18- copy hex color codes to clipboard 18 - tetrads
19- clean, minimal interface 19 - analogous
20 - monochromatic
21- compact top swatch cards with centered overlay metadata:
22 - hex
23 - rgb
24 - hsv
25- dynamic overlay text contrast (light/dark text based on background luminance)
26- toolbar actions: back, forward, random, lighten, darken, saturate, desaturate, paste
27- click a top swatch to promote it to the active base color
28- right-click on top swatches and palette swatches to copy:
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)
20 49
21## requirements 50## requirements
22 51
23- go 1.21 or higher 52- go 1.21 or higher
24- gtk3 development libraries 53- gtk3 development libraries
25- `gotk3` go bindings 54- `gotk3` Go bindings
26- `xcolor` 55- optional for pick-from-screen: `xcolor` or `grabc`
27 56
28## installation 57## installation
29 58
@@ -34,15 +63,11 @@ cd archlinux
34makepkg -si 63makepkg -si
35``` 64```
36 65
37see `archlinux/README.md` for more details.
38
39### manual build 66### manual build
40 67
41```sh 68```sh
42cd src 69cd src
43go mod download 70go build -o kjagave .
44go mod download github.com/gotk3/gotk3
45go build -o kjagave main.go
46``` 71```
47 72
48## running 73## running
@@ -53,12 +78,8 @@ go build -o kjagave main.go
53 78
54## usage 79## usage
55 80
561. use the color picker button to open the full color selection dialog 811. pick a base color with the color button, hex entry, palette swatches, or screen picker
572. **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 822. choose a scheme type
583. click "Copy to Clipboard" to copy the hex color code 833. click a preview swatch to make it the active base color
594. click "Save..." to save the current color to your favorites list 844. right-click a swatch to copy hex/hsv/rgb
605. expand "Saved Colors" to view and manage your saved colors 855. use favorites controls (`+`, `-`, rename, clear) to manage saved colors \ No newline at end of file
616. select a saved color to load it in the picker
627. click "Delete" to remove a selected saved color
63
64saved colors are stored in `~/.config/kjagave.json` as json.