@kecan0406/ttheme 1.0.41 → 1.0.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -82,6 +82,22 @@ Both images are drawn from the live catalog, so they always match what
82
82
  adds or drops single palettes any time, and a merged palette reaches everyone
83
83
  through `ttheme update` without waiting for a release.
84
84
 
85
+ ### Your own palettes
86
+
87
+ `ttheme new dusk --from madoka` copies a palette into
88
+ `~/.config/ttheme/palettes/<you>/dusk.toml`, named after your GitHub handle
89
+ (`<you>/dusk`), and installs it. `ttheme edit` opens it in `$EDITOR` and
90
+ refuses a result that fails the contrast gate, offering colors that pass;
91
+ `ttheme check --fix` does the same for any palette of yours.
92
+
93
+ `ttheme share <palette>` prints a code — `tt1:…`, about 200 characters — that
94
+ carries the colors and the numbers of its background posts with their framing.
95
+ `ttheme add tt1:…` installs it anywhere, fetching those posts from the booru the
96
+ way `find` does. `ttheme submit <palette>` opens a filled-in GitHub issue; a bot
97
+ checks it and turns it into a pull request for the catalog, where it appears
98
+ as `<you>/<palette>` next to the palette it came from. A palette that leaves the
99
+ catalog keeps working for whoever installed it.
100
+
85
101
  ## Usage
86
102
 
87
103
  | Command | |
@@ -92,6 +108,7 @@ through `ttheme update` without waiting for a release.
92
108
  | `ttheme default <palette>` | the palette new tabs open with |
93
109
  | `ttheme pin` / `unpin` | a palette for this directory — `cd` in repaints, `cd` out restores |
94
110
  | `ttheme browse` | pick palettes from the catalog |
111
+ | `ttheme new <name> --from <palette>` | make a palette of your own; `edit`, `check`, `share`, `submit` follow |
95
112
  | `ttheme on` / `off` | wear the default again / give the terminal its own colors back |
96
113
  | `ttheme config` | settings in `$EDITOR` |
97
114
 
@@ -121,7 +138,8 @@ window. See [docs/backgrounds.md](docs/backgrounds.md).
121
138
 
122
139
  ## Contributing
123
140
 
124
- A palette is one TOML file of color values — never images.
141
+ A palette is one TOML file of color values and post numbers — never images.
142
+ `ttheme submit` sends one of yours without a checkout;
125
143
  [CONTRIBUTING.md](CONTRIBUTING.md) has the rules, the file format and the
126
144
  checks it must pass.
127
145