Skip to content

Commit 7aa966b

Browse files
committed
docs: improve README with numbered steps and supported AI tools table
1 parent 17531c1 commit 7aa966b

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

README.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,26 @@
1717

1818
## TLDR
1919

20-
**Install the workflow prompts as slash commands:**
20+
1. Install the workflow prompts as slash commands in all your [local AI tools](#supported-ai-tools):
2121

22-
```bash
23-
uvx --from git+https://github.com/liatrio-labs/spec-driven-workflow sdd-generate-commands generate --yes
24-
```
22+
```bash
23+
uvx --from git+https://github.com/liatrio-labs/spec-driven-workflow sdd-generate-commands generate --yes
24+
```
2525

26-
**Use `/generate-spec` with your idea:**
26+
2. In your AI tool of choice, use `/generate-spec` with your idea:
2727

28-
```text
29-
I want to add user authentication to my app
30-
```
28+
```text
29+
/generate-spec I want to add user authentication to my app
30+
```
3131

32-
→ AI asks clarifying questions → You provide answers → Spec created in `tasks/0001-spec-user-auth.md`
32+
→ AI asks clarifying questions → You provide answers → Spec created in `tasks/0001-spec-user-auth.md`
3333

34-
**Continue the flow:**
34+
3. Continue the flow:
3535

36-
- Run `/generate-task-list-from-spec` → Task list created in `tasks/tasks-0001-spec-user-auth.md`
37-
- Use `/manage-tasks` → Execute tasks one-by-one with proof artifacts
38-
- **SHIP IT** 🚢💨
36+
- Run `/generate-task-list-from-spec` → Task list created in `tasks/tasks-0001-spec-user-auth.md`
37+
- Use `/manage-tasks` → Execute tasks one-by-one with proof artifacts
38+
39+
4. **SHIP IT** 🚢💨
3940

4041
## Highlights
4142

@@ -149,6 +150,23 @@ The SDD workflow can be used in three ways, from simplest to most automated:
149150

150151
### Option 2: Native Slash Commands (Recommended)
151152

153+
#### Supported AI Tools
154+
155+
The slash command generator currently supports the following AI coding assistants:
156+
157+
| AI Tool | Command Install Location |
158+
|--------------|--------------------------------------------------|
159+
| Claude Code | `~/.claude/commands` |
160+
| Codex CLI | `~/.codex/prompts` |
161+
| Cursor | `~/.cursor/commands` |
162+
| Gemini CLI | `~/.gemini/commands` |
163+
| VS Code | `~/.config/Code/User/prompts` |
164+
| Windsurf | `~/.codeium/windsurf/global_workflows` |
165+
166+
For full setup and agent-specific details, see [docs/slash-command-generator.md](./docs/slash-command-generator.md).
167+
168+
#### Slash Command Installation
169+
152170
Generate slash commands for your AI coding assistant and use the prompts as native commands:
153171

154172
```bash

0 commit comments

Comments
 (0)