Skip to content

Commit 53a1e3b

Browse files
tigCopilot
andcommitted
Remove bespoke script guidance; README.md is the single source
Agents should follow the general workflow in README.md rather than creating per-scenario tuirec scripts. If something is unclear enough that an agent creates a bespoke script, the README should be improved. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent c445b2f commit 53a1e3b

2 files changed

Lines changed: 6 additions & 19 deletions

File tree

Scripts/tuirec/README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -125,28 +125,17 @@ Copy-Item artifacts/<ScenarioName>.gif Examples/UICatalog/Scenarios/<ScenarioDir
125125

126126
### Output File Placement
127127

128-
Scenario demo GIFs and any bespoke recording scripts live **alongside their
129-
scenario source code**:
128+
GIFs live **alongside the `.cs` file they document**:
130129

131-
```
132-
Examples/UICatalog/Scenarios/<ScenarioDir>/<ScenarioName>.gif
133-
Examples/UICatalog/Scenarios/<ScenarioDir>/<ScenarioName>-tuirec.ps1 (optional)
134-
```
135-
136-
For scenarios whose `.cs` file lives directly in `Scenarios/` (no subdirectory),
137-
the GIF and script go in that same folder (e.g.
138-
`Scenarios/AllViewsTester.gif` next to `Scenarios/AllViewsTester.cs`).
139-
140-
For **View-derived classes**, the GIF and optional script go in the same folder
141-
as the View's `.cs` file (e.g. `Terminal.Gui/Views/Button.gif`).
130+
| What | Where |
131+
|------|-------|
132+
| Scenario in a subdirectory | `Examples/UICatalog/Scenarios/<ScenarioDir>/<ScenarioName>.gif` |
133+
| Scenario directly in `Scenarios/` | `Examples/UICatalog/Scenarios/<ScenarioName>.gif` |
134+
| View-derived class | Same folder as the View's `.cs` file (e.g. `Terminal.Gui/Views/Button.gif`) |
142135

143136
Use `--name <ScenarioName>` (PascalCase matching the class name) so the output
144137
file is named correctly. The `--name` value determines the artifact filenames.
145138

146-
A `*-tuirec.ps1` script is only needed when the default recording workflow
147-
requires scenario-specific overrides (custom keystrokes, non-default cols/rows,
148-
etc.). For simple recordings, just follow the template command below.
149-
150139
### Critical: `--kitty-keyboard` Decision
151140

152141
**Known bug ([gui-cs/tuirec#54](https://github.com/gui-cs/tuirec/issues/54)):**

Scripts/tuirec/hero-gif.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,3 @@ PowerShell quoting rules, and the `--kitty-keyboard` decision tree.
2929
`Examples/UICatalog/Scenarios/<ScenarioDir>/<ScenarioName>.gif`
3030
- **View GIFs** go alongside the View's `.cs` file:
3131
`Terminal.Gui/Views/<ViewName>.gif`
32-
- **Bespoke recording scripts** (when needed) use the naming convention:
33-
`<ClassName>-tuirec.ps1` in the same directory as the `.cs` file.

0 commit comments

Comments
 (0)