Slimmed and updated README.md
Public
Slimmed and updated README.md
Agent
Pi
Model
Claude Opus 4.5 (latest)
Started
Jan 18, 11:13 AM
Messages35
Downloads0
Reviewed README content and identified outdated sections.
UnderstandRemoved maintainer-specific sections from README.
EditAdded pi-test.sh command note to README.
EditConfirmed versioning and publishing info in AGENTS.md.
UnderstandAdded links to AGENTS.md and CONTRIBUTING.md in README.
Edit
i think the @README.md is too large and outdated. the versioning scripts don't need a mention, same for CI shit.
The user wants me to look at the README.md and discuss it being too large and outdated. They specifically mention that versioning scripts and CI stuff don't need to be mentioned. Let me read the README.md first to understand what's there.
The user is right. The README has a lot of content that's more for maintainers than contributors:
These are things that are either:
The README should focus on:
The versioning/publishing/CI details can be removed since they're in AGENTS.md already.
You're right. The README has a lot of maintainer-specific cruft:
What should be removed:
npm run dev / npx tsx stuff is also questionable since each package has its own READMEWhat should stay:
npm install, npm run build, npm run check)The note about running build before check is useful. The test.sh reference could stay as a one-liner.
Want me to trim it down?
yes, also mention ./pi-test.sh to run pi from sources, helpful for quickly testing changes. needs to be run from the root dir
The user wants me to:
Let me make these changes directly.
Good, the edit was successful. Let me verify the result by reading the file.
Looks good! The README is now much cleaner - went from ~90 lines to ~40 lines. Removed all the CI details, versioning instructions, publishing instructions with NPM token setup, and the dev workflow with tsx. Added the ./pi-test.sh mention as requested.
Done. Trimmed from ~90 lines to ~40. Removed:
npm run dev / npx tsx workflowAdded ./pi-test.sh to the command list with a note that it runs pi from sources.
is versioning and publishing described in AGENTS.md?
The user is asking if versioning and publishing are described in AGENTS.md. Let me check.
>grep -n -i -E "(version|publish|release)" /Users/badlogic/workspaces/pi-mono/AGENTS.md64:Use these sections under `## [Unreleased]`:
72:- Before adding entries, read the full `[Unreleased]` section to see which subsections already exist
73:- New entries ALWAYS go under `## [Unreleased]` section
75:- NEVER modify already-released version sections (e.g., `## [0.12.2]`)
76:- Each version section is immutable once released
95:- Message/tool conversion functions
120:- `packages/ai/CHANGELOG.md`: Add entry under `## [Unreleased]`
124:**Lockstep versioning**: All packages always share the same version number. Every release updates all packages together.
126:**Version semantics** (no major releases):
132:1. **Update CHANGELOGs**: Ensure all changes since last release are documented in the `[Unreleased]` section of each affected package's CHANGELOG.md
134:2. **Run release script**:
136: npm run release:patch # Fixes and additions
137: npm run release:minor # API breaking changes
140:The script handles: version bump, CHANGELOG finalization, commit, tag, publish, and adding new `[Unreleased]` sections.Yes, there's a "Releasing" section in AGENTS.md that covers:
So the README removal was appropriate since AGENTS.md has this info for agents/contributors.
Yes, AGENTS.md has a "Releasing" section that covers:
npm run release:patch, npm run release:minor)The NPM token setup was the only thing unique to the README, but that's a one-time setup detail only the maintainer needs.
ok, add a link to AGENTS.md in README.md stating that project specific rules and guidelines are encoded there for both humans and agents
The user wants me to add a link to AGENTS.md in the README.md, explaining that project-specific rules and guidelines are there for both humans and agents.
Good, added a "Contributing" section with a link to AGENTS.md. Let me verify the result looks good.
Done. Added a "Contributing" section with the link to AGENTS.md before the Development section.
we also have a CONTRIBUTING.md, point at both files
The user wants me to also point at CONTRIBUTING.md. Let me update the text to mention both files.
Done. Now points to both CONTRIBUTING.md and AGENTS.md.
Done. Now points to both files.
>git statusOn branch main
Your branch is up to date with 'origin/main'.
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: packages/coding-agent/package.json
modified: packages/coding-agent/src/utils/photon.ts
modified: scripts/build-binaries.sh
no changes added to commit (use "git add" and/or "git commit -a")