Restructure README with Judge Links First

Claude Code·Opus 5.5·Jennycruzy·5d ago·7min·1 Checkpoint·2 file changes·+54/-37·4.8K tokens

You are working in the Trueup repository (this folder). Foreground only. Do not commit, push or post. Never print or write a key. No private paths. Plain words only (no: span, trace as a noun for people, lead, scenario, harness, adapter, instrumentation, OTel). Finish within 12 minutes. Edit README.md only.

Goal: make README.md lead with the links a judge needs to open, then high-quality, copy-paste code. Keep it under about 450 words. Keep the existing sections that still matter, but restructure:

  1. # Trueup Witness + the one-line description (keep).
  2. For judges, start here — a short list of links, each with a few plain words saying what it proves:
  3. The result table (2 → 0, 40 normal calls, 0 false alarms) — keep, short.
  4. Install and Quick start: keep the existing working code block; check it against src/trueup/witness/core.py and make sure it is exactly right and copy-pastes cleanly. Add a second short block showing entire trueup --help (Trueup runs as an Entire command) and trueup audit examples/agent.py --library neatlogs (check your own script against the practice AI server). Verify both commands run (uv run trueup audit --help is enough for the second if a full run is slow).
  5. How it works (4 lines), Docs list, License — keep, short. Run uv run pytest -q (some tests read README). Fix only README wording if a test needs it; never weaken a number check. Print the final README word count and the test result.
5d ago·2m

I rewrote README.md. It's now 405 words, and uv run pytest -q: 447 passed, 19 deselected. I changed no other file and didn't commit or push.

New order: the title and one-line description, then "For judges, start here" with every link you listed, each with a few words on what it proves. After that come the result table (2 → 0, 40 normal calls, 0 false alarms), Install, Quick start, the command-line block, How it works in 4 lines, Docs and License. The link to our mistake with Entire goes to hackathon.md#what-entire-recorded-and-what-it-did-not-12-oct-observed. That is how GitHub turns that heading into an anchor; I didn't click it on GitHub itself.

Quick start: I checked it against src/trueup/witness/core.py. watch() and run(name) match the code, run.disagreements is filled in when the with block ends, and TRUEUP_WITNESS=0 turns it off. To make it copy-paste cleanly I added the import os and neatlogs.init(...) lines, taken from docs/getting-started.md. I checked those against neatlogs' real init. One limit: agent.handle(...) is still a stand-in for the reader's own agent, marked # your own agent call. The block won't run as pasted until they put their own call there.

Command-line block:

  • trueup audit --help runs correctly. I didn't do a full audit run.
  • entire trueup --help only works when Trueup's entire-trueup command is on the PATH. Inside the project (uv run entire trueup --help) it shows Trueup's help. From a plain shell here, it showed Entire's own help instead, because Trueup's environment wasn't active. After pip install ./trueup into the active Python it should work; I didn't test that case. If judges might run it from a fresh clone, the README could say uv run entire trueup --help instead.

Removed to stay short: the "Why" line, the "Really: Crashed" column of the table, the old "Fixes sent upstream" paragraph and the "Built with" section. Their links are all in the judges' list now. I also took the email and build-log links out of the Docs line, since the list above already has them.