Write a README for my project

Create documentation from the actual code, not guesses.

CodeStep by step

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

Make sure Shellway is connected in ChatGPT, Claude or Cursor.
Paste the prompt and change the folder names or paths to match your computer.
Review the plan your AI shows before you confirm any changes.

Related prompts

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.

Check my repos for uncommitted work

Find every project with changes you have not committed or pushed.