Skip to content

Commit a5cf7c1

Browse files
authored
Merge pull request #15 from nicobailon/claude/add-prompt-install-docs-giw4I
docs: add prompt template install instructions for Claude Code and Pi
2 parents 9ee2567 + ad99616 commit a5cf7c1

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,29 @@ Tables are worse. Ask the agent to compare 15 requirements against a plan and yo
2828

2929
## Install
3030

31+
### Pi
32+
3133
```bash
32-
# Pi — installs the skill and all slash commands in one step
34+
# Installs the skill and all slash commands in one step
3335
pi install https://github.com/nicobailon/visual-explainer
3436
```
3537

36-
For Claude Code or other agents, clone into your skills directory:
38+
If you prefer a manual install, clone the repo and copy the prompts:
39+
40+
```bash
41+
git clone https://github.com/nicobailon/visual-explainer.git ~/.pi/agent/skills/visual-explainer
42+
mkdir -p ~/.pi/agent/prompts
43+
cp ~/.pi/agent/skills/visual-explainer/prompts/*.md ~/.pi/agent/prompts/
44+
```
45+
46+
### Claude Code
47+
48+
Clone the skill, then copy the prompt templates so they register as slash commands:
3749

3850
```bash
3951
git clone https://github.com/nicobailon/visual-explainer.git ~/.claude/skills/visual-explainer
52+
mkdir -p ~/.claude/commands
53+
cp ~/.claude/skills/visual-explainer/prompts/*.md ~/.claude/commands/
4054
```
4155

4256
If you have [surf-cli](https://github.com/nicobailon/surf-cli) installed, the skill can also generate illustrations via Gemini and embed them in pages. The agent detects surf automatically and skips image generation if it's not there.

0 commit comments

Comments
 (0)