Pārlūkot izejas kodu

AGENTS: a mood word may be a profile name; load, then read back with info

Paul Klumpp 5 dienas atpakaļ
vecāks
revīzija
6dab7d6198
1 mainītis faili ar 15 papildinājumiem un 0 dzēšanām
  1. 15 0
      AGENTS.md

+ 15 - 0
AGENTS.md

@@ -23,6 +23,21 @@ For the effect catalog specifically, read it from no document at all. Run
 effects than Backlight, and only the tool knows what the current firmware
 effects than Backlight, and only the tool knows what the current firmware
 supports.
 supports.
 
 
+## Driving the Tool for a User
+
+When a user asks for a look or a mood — "stell auf lava", "mach es bunt",
+"set it back to white" — the word may be a **profile name** before it is an
+effect name. Check `qmk-rgb-tool list` first; a saved profile is the one answer
+that restores the whole state (effect, brightness, speed, color per channel),
+which no single effect command reproduces. Only when no profile matches do the
+effect catalog (`effect all`) and the color commands come into play — and if
+neither names a match, ask, instead of picking the nearest-sounding effect.
+
+`load` prints nothing on success: warnings go to stderr only, one per skipped
+zone or unresolvable name. Silence is the success case, confirmed by `info`,
+which is the read-back that says what the keyboard actually holds — run it
+before telling the user it is applied.
+
 ## Keep README.md Short, Because a Person Reads It
 ## Keep README.md Short, Because a Person Reads It
 
 
 A fact belongs in README.md only while it changes what someone types. The
 A fact belongs in README.md only while it changes what someone types. The