How to use the README Generator.
A README should make setup reproducible from verified requirements. Distinguish instructions that were checked from proposed commands or unavailable configuration.
Make the workflow fit your task.
Use the repository's actual scripts, prerequisites and configuration to explain setup and first use. Distinguish verified commands from proposed steps and keep secrets out of examples, with a clear route to testing.
- What you provide
- Verified project behavior and setup requirements.
- What you get
- Project documentation with runnable steps needing verification.
See the input and the result.
Illustrative input and output · a teaching example, not a live WebAct run
Example input
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
Completed example
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
Load this input into the prompt, then copy it to WebAct to try the task. Your result may differ from the illustration.
Decisions and troubleshooting.
Should a README invent an installation command that sounds conventional?
Check the project first. A familiar command may be wrong for the package manager, lockfile or build process used.
Why does setup fail despite following the README?
Compare runtime versions, required configuration and the actual scripts. Reproduce the missing step rather than adding a vague troubleshooting paragraph.
Try it with your own source.
Replace the example with your material in the task prompt. Keep the requirements you need, then copy the task into WebAct.
Customize and copy the task ↑