README Generator
Turn a bare repository into a README a stranger could actually follow — what it does, how to install it, how to run it, and how to contribute.
The prompt
Write a clear README for the project below. Include: a one-line description, why it exists, installation, usage with at least one real example, configuration, and contribution notes. Skip any section that doesn't apply rather than padding it:
{{project_details}}Works in ChatGPT, Claude, Gemini and other assistants. Replace the highlighted placeholders with your own content.
How to use it
Fill {{project_details}} with what the project does, how it is installed and run, and any key commands. The prompt returns a README a newcomer could follow from top to bottom.
Tips for better results
- Paste your package manifest or build file so install steps are accurate.
- Run every command in the README yourself before publishing.
- Ask for a short “Quick start” at the top if the project is large.
Save this prompt in Promta
Keep it in your library and paste it from the menu bar, a hotkey or your iPhone keyboard, without leaving the app you're in.
Download Free on App Store
Free to start · iPhone & Mac