Skip to content

Commit 02fa54f

Browse files
committed
docs: simplify README setup flow
1 parent 8b9212c commit 02fa54f

1 file changed

Lines changed: 73 additions & 71 deletions

File tree

README.md

Lines changed: 73 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,78 @@
11
# TLDR.md — Too Long Didn't Read
22

3-
**The tiny prompt that gets your agent to the point.**
3+
**Tiny prompt. Shorter answers. Same brain.**
44

5-
TLDR.md makes AI assistants answer directly — no filler, no fake enthusiasm, no “let me know if... sludge.
5+
TLDR.md makes AI assistants answer directly: less filler, less fake enthusiasm, less "let me know if..." sludge.
66

7-
It is literally just a tiny Markdown prompt. Copy it where your agent reads instructions.
7+
> It changes communication style only.
8+
> Tools, reasoning, code quality, and safety stay the same.
89
9-
> **It does NOT make the model DUMBER.**
10-
>
11-
> It **ONLY CHANGES** the **COMMUNICATION STYLE**.
12-
13-
## Current defaults
14-
15-
- default: 1 sentence
16-
- target: 3 words
17-
- 1 word when sufficient
18-
- default max: 6 words
19-
- longer only if asked
20-
- greet: 1 word
21-
22-
## Which file should I use?
10+
## Pick one
2311

2412
| File | Use this if... |
2513
|---|---|
26-
| [`TLDR.md`](TLDR.md) | You want concise output — works for coding agents (`AGENTS.md`, `CLAUDE.md`, `GEMINI.md`, Cursor/Cline rules) and chat apps (ChatGPT, Claude, Gemini, Perplexity). |
27-
| [`TLDR.blunt.md`](TLDR.blunt.md) | You want TLDR.md's terseness AND want the model to value its own assessment over user agreement — push back when warranted, comply on explicit override ("anyway", "I'm overriding"). |
28-
29-
## Quick install
30-
31-
### Coding agents
32-
33-
Manual install:
34-
35-
1. Open [`TLDR.md`](TLDR.md).
36-
2. Copy the prompt.
37-
3. Paste it at the **top** of your agent instruction file.
14+
| [`TLDR.md`](TLDR.md) | You want terse output. Start here. |
15+
| [`TLDR.blunt.md`](TLDR.blunt.md) | You want terse output plus less sycophancy / more pushback when warranted. |
3816

39-
You can also add [`TLDR.md`](TLDR.md) to the top of your `AGENTS.md` or global equivalent.
17+
## Fastest setup
4018

41-
Need the right file path? See [`common agent locations`](data/agent-locations.md).
19+
### 1) Pick a variant
4220

43-
### ChatGPT / Claude / Gemini / Perplexity
21+
```bash
22+
# Regular
23+
TLDR_URL=https://raw.githubusercontent.com/jqbit/TLDR.md/main/TLDR.md
4424

45-
Copy [`TLDR.md`](TLDR.md) into your app's custom instructions, project instructions, system prompt, or saved prompt.
25+
# Blunt
26+
TLDR_URL=https://raw.githubusercontent.com/jqbit/TLDR.md/main/TLDR.blunt.md
27+
```
4628

47-
## What it fixes
29+
### 2) Install to the 7 standard coding-agent locations
4830

49-
Default AI often writes like this:
31+
```bash
32+
: ${TLDR_URL:=https://raw.githubusercontent.com/jqbit/TLDR.md/main/TLDR.md}
5033

51-
> Sure — here’s a comprehensive breakdown of the command you can use, why it works, and a few things to keep in mind...
34+
for d in ~/.claude/CLAUDE.md ~/.gemini/GEMINI.md ~/.codex/AGENTS.md \
35+
~/AGENTS.md ~/.config/opencode/AGENTS.md \
36+
~/.factory/AGENTS.md ~/.pi/agent/AGENTS.md; do
37+
mkdir -p "$(dirname "$d")" && curl -fsSL "$TLDR_URL" -o "$d"
38+
done
39+
```
5240

53-
TLDR mode pushes it toward this:
41+
### 3) Hermes uses `~/.hermes/SOUL.md`
5442

5543
```bash
56-
git reset --soft HEAD~1
44+
mkdir -p ~/.hermes
45+
curl -fsSL "$TLDR_URL" -o ~/.hermes/SOUL.md
5746
```
5847

59-
Other stuff it cuts:
60-
61-
- repeating your question back to you
62-
- unnecessary caveats
63-
- “here’s a breakdown” preambles
64-
- explaining when you asked for only a command
65-
- summary paragraphs you did not ask for
66-
- “let me know if you want me to...” endings
48+
If you already have a Hermes persona, merge TLDR into `SOUL.md` instead of blindly replacing it.
6749

68-
## Why not just use caveman mode?
50+
### 4) Chat apps
6951

70-
Caveman-style prompting helped prove that agents can be much more concise. TLDR.md is inspired by that idea.
52+
Paste the file into custom instructions, project instructions, system prompt, or saved prompt.
7153

72-
The difference: TLDR.md aims for concise output **without** turning the assistant into a character. No roleplay. No broken tone. Just shorter answers.
73-
74-
## Benchmarks
75-
76-
Current prompt sizes:
77-
78-
| File | Bytes |
79-
|---|---:|
80-
| [`TLDR.md`](TLDR.md) | 1,165 |
81-
| [`TLDR.blunt.md`](TLDR.blunt.md) | 1,487 |
54+
Need exact paths, per-agent notes, or Cursor/Hermes caveats? See [`data/agent-locations.md`](data/agent-locations.md).
8255

83-
Headline historical results:
56+
## Verify
8457

85-
Note: results below were measured on earlier shipped prompts. The current prompt files were later tightened to a 1-sentence / 3-word-default / 6-word-max profile and have not yet been rerun through the full bench.
58+
```bash
59+
for p in ~/.claude/CLAUDE.md ~/.gemini/GEMINI.md ~/.codex/AGENTS.md \
60+
~/AGENTS.md ~/.config/opencode/AGENTS.md \
61+
~/.factory/AGENTS.md ~/.pi/agent/AGENTS.md; do
62+
[ -f "$p" ] && grep -q "^# TLDR" "$p" && echo "$p" || echo "$p"
63+
done
8664

87-
- **TLDR.md v0.13.1:** −82.1% total prose reduction, 100% average compliance (5 agents × 5 prompts).
88-
- **TLDR.md v0.14.3:** −80.0% single-turn prose reduction; −75.1% across 8-turn coding conversations; no significant decay.
89-
- **TLDR.blunt.md v0.18.0:** DSPy round-2 + 5-agent cross-model validation; avg pushback 0.848, correct-user agreement 0.912, mean prose 11.0 words, validation phrases 0%.
65+
grep -q "target 3 words" ~/.hermes/SOUL.md 2>/dev/null && echo "✓ ~/.hermes/SOUL.md" || echo "✗ ~/.hermes/SOUL.md"
66+
```
9067

91-
The regular `TLDR.md` prompt was tested in two DSPy optimization runs; no candidate beat the shipped v0.16.0 prompt on the current metric. `TLDR.blunt.md` improved materially in v0.18.0, especially on opencode pushback (0.38→0.81) and cursor correct-user agreement (0.44→0.89).
68+
## Current defaults
9269

93-
See [`data/benchmarks.md`](data/benchmarks.md), [`data/dspy-cross-model-results.md`](data/dspy-cross-model-results.md), and [`data/changelog.md`](data/changelog.md) for methodology, full tables, caveats, and historical runs.
70+
- default: 1 sentence
71+
- target: 3 words
72+
- 1 word when sufficient
73+
- default max: 6 words
74+
- longer only if asked
75+
- greet: 1 word
9476

9577
## Example outputs
9678

@@ -106,15 +88,35 @@ Yes. Start SQLite.
10688
git reset --soft HEAD~1
10789
```
10890

109-
## Share line
91+
## What it fixes
92+
93+
- question restatement
94+
- fake enthusiasm / validation
95+
- command wrappers when you asked for only the command
96+
- extra caveats and summary paragraphs
97+
- "let me know if you want more" endings
11098

111-
```text
112-
TLDR.md gets agents to the point.
113-
```
99+
## Benchmarks (historical)
100+
101+
Current prompt sizes:
102+
103+
| File | Bytes |
104+
|---|---:|
105+
| [`TLDR.md`](TLDR.md) | 1,165 |
106+
| [`TLDR.blunt.md`](TLDR.blunt.md) | 1,487 |
107+
108+
These benchmark results were measured on earlier shipped prompts. The current prompt files were later tightened to a 1-sentence / 3-word-default / 6-word-max profile and have not yet been rerun through the full bench.
114109

115-
## Contributing
110+
- **TLDR.md v0.13.1:** −82.1% total prose reduction, 100% average compliance (5 agents × 5 prompts).
111+
- **TLDR.md v0.14.3:** −80.0% single-turn prose reduction; −75.1% across 8-turn coding conversations; no significant decay.
112+
- **TLDR.blunt.md v0.18.0:** DSPy round-2 + 5-agent cross-model validation; avg pushback 0.848, correct-user agreement 0.912, mean prose 11.0 words, validation phrases 0%.
116113

117-
Want to improve the prompt, add an agent path, or share benchmark results? See [`CONTRIBUTING.md`](CONTRIBUTING.md).
114+
Full historical details:
115+
- [`data/agent-locations.md`](data/agent-locations.md)
116+
- [`data/benchmarks.md`](data/benchmarks.md)
117+
- [`data/dspy-cross-model-results.md`](data/dspy-cross-model-results.md)
118+
- [`data/changelog.md`](data/changelog.md)
119+
- [`CONTRIBUTING.md`](CONTRIBUTING.md)
118120

119121
## License
120122

0 commit comments

Comments
 (0)