Skip to content

Commit 11ddc0c

Browse files
committed
docs: simplify install section
Make the README install flow easier to scan by surfacing one-agent install paths directly and pointing users to `INSTALL.md` for the full matrix. Also ignore the local `tmp-starcharts/` scratch directory so generated chart work stays out of git.
1 parent 14d4f2e commit 11ddc0c

2 files changed

Lines changed: 9 additions & 11 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ context/refs/research-brief-caveman-code-efficiency.md
1212
# Build artifacts
1313
dist/*
1414
!dist/caveman.skill
15+
16+
# Local star-history chart scratch (not part of the product)
17+
tmp-starcharts/

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,7 @@ irm https://raw.githubusercontent.com/JuliusBrussee/caveman/main/install.ps1 | i
101101

102102
~30 seconds. Needs Node ≥18. Skips agents you no have. Safe to re-run.
103103

104-
> [!TIP]
105-
> **Turn it on:** type `/caveman` or say *"talk like caveman"*. **Turn it off:** say *"normal mode"*. On Claude Code, Codex, and Gemini it's already on from message one. No command needed.
106-
107-
<details>
108-
<summary><strong>Install for one agent, or any of 30+ others</strong></summary>
109-
110-
<br>
111-
112-
Every agent has its own path (plugin, extension, rule file, or `npx skills add`). The full per-agent matrix, all flags, dry-run, and uninstall live in **[INSTALL.md](./INSTALL.md)**. A few common ones:
104+
Prefer one agent at a time? Each has its own path:
113105

114106
```bash
115107
# Claude Code plugin
@@ -122,9 +114,12 @@ gemini extensions install https://github.com/JuliusBrussee/caveman --consent
122114
npx skills add JuliusBrussee/caveman -a cursor
123115
```
124116

125-
**Install broke?** Open your agent in this repo and say: *"Read CLAUDE.md and INSTALL.md, install caveman for me."* Agent read repo, agent fix own brain. Snake eat tail.
117+
The full per-agent matrix, all flags, dry-run, and uninstall live in **[INSTALL.md](./INSTALL.md)**.
126118

127-
</details>
119+
> [!TIP]
120+
> **Turn it on:** type `/caveman` or say *"talk like caveman"*. **Turn it off:** say *"normal mode"*. On Claude Code, Codex, and Gemini it's already on from message one. No command needed.
121+
122+
**Install broke?** Open your agent in this repo and say: *"Read CLAUDE.md and INSTALL.md, install caveman for me."* Agent read repo, agent fix own brain. Snake eat tail.
128123

129124
## Pick your grunt
130125

0 commit comments

Comments
 (0)