Write a README for my project
Create documentation from the actual code, not guesses.
The prompt
Read the project in ~/code/my-app and write a README.md with: what it does, requirements, setup steps, how to run tests and the main folders. Show me the draft before saving it.
How to use it
Related prompts
Fix my website with Chrome's Modern Web Guidance
Scan your site for outdated patterns and fix forms and loading with Google Chrome's open-source guidance.
Explain a codebase
Get a plain-English map of an unfamiliar project and where to start.
Fix failing tests
Run the test suite, find why tests fail and fix them.