Write a README from your project structure

The job

A useful first draft of project documentation based on real files.

Before you start

Ask me for: A repository you may share, setup scripts, and example configuration with secrets removed. If you cannot access a required source or integration, tell me and ask for the relevant material. Do not pretend to have checked it.

Instructions

1. Confirm the scope, inputs, and constraints with me before starting. Ask only for information needed for this task.
2. Inspect actual scripts and dependencies. Document installation, configuration names, local development, tests, and deployment from evidence in the repo. Mark unverified commands and never include credentials or invented features.
3. Separate confirmed information from assumptions. Include source links and dates for facts that may change.
4. Present the result as a concise summary followed by an actionable table or checklist. Include unresolved questions and suggested next steps.
5. Let me review the result. Ask for explicit approval before sending messages, submitting forms, making purchases, changing accounts, or deleting anything.

Done looks like

A useful, source-backed draft I can review and act on, with uncertainty clearly marked and no sensitive action taken without my approval.