Skip to content

README quickstart and AI agent guide - #11

Merged
bk1202 merged 2 commits into
mainfrom
docs/launch-readme
Oct 23, 2026
Merged

bk1202 merged 2 commits into
mainfrom
docs/launch-readme

Conversation

@bk1202

@bk1202 bk1202 commented Oct 23, 2026 •

Copy link
Copy Markdown
Owner

The README now opens with what ProofCLI checks, why an exit code of 0 is not enough, and a command that installs the PyPI package and runs a starter contract. No git clone is required for that starter.

Under those lines is a still of a real run of the broken exporter. The exporter exits 0. ProofCLI exits 1 because Grace's amount is 999.00 instead of 8.25. The picture is the command's own output, drawn with the existing release screenshot tool.

The 0.4.2 wheel does not include the example files. A new section downloads the contract, the exporter, and the fixture from the v0.4.2 tag and runs proofcli run. proofcli init stays a separate passing starter. It does not create this exporter.

docs/ai-agents.md says to have an agent run a contract before calling the work done, and to run the same check with the GitHub Action on pull requests. The README links to it. The still is docs/assets/wrong-value-failure.png.

@bk1202
bk1202 marked this pull request as ready for review October 23, 2026 15:30
@bk1202
bk1202 merged commit 8b4cdfa into main Oct 23, 2026
28 checks passed
@bk1202
bk1202 deleted the docs/launch-readme branch October 23, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant