Audit a README against the project it describes

A README should help a new reader run the current project. Check commands, paths and prerequisites against the repository rather than polishing prose in isolation.

Use a reviewable project copy

Give the product or code teammate the relevant specification and a dedicated project folder or branch. Separate a proposed change from permission to release it. Request a diff or evidence table alongside the recommendation, and run checks that exercise the behavior in question. Generated code and test output still need review in the actual project environment.

Inputs for this workflow: A project copy, README and package or build configuration.

Work through the task

1. Compare documented commands with defined scripts.
2. Identify stale paths and missing prerequisites.

A brief you can adapt

Write readme-audit.md with claim, supporting file, mismatch and proposed edit. Do not run unknown setup scripts without review.

The filenames above are examples. Replace them with your actual inputs and destination before submitting the task.

Review the deliverable

Test approved setup commands in an appropriate disposable environment and record what was actually verified.

Where this approach can fail

A plausible command is not evidence that the project supports it.

For the related desktop setup, see local folder.