README for a Small Project
Write a clear README with setup, usage and troubleshooting.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
Write a README for my project. What it does: [PROJECT_DESCRIPTION]. Who uses it: [USERS]. Language and tools: [STACK]. Install steps I know: [INSTALL_STEPS]. Example usage: [USAGE_EXAMPLE]. Licence: [LICENCE]. Use these sections: a one-sentence summary; why it exists; requirements; installation as numbered commands; quick start with a runnable example; configuration table with option, default and meaning; common errors and fixes; how to contribute; licence. Keep sentences short and put commands in code blocks. Do not invent features, flags or versions. Where my details are incomplete, insert a visible TODO so I can complete them. Finish with a checklist to verify the README by following it on a clean machine. Add a short troubleshooting table with three common problems and fixes, using only the problems I mention, and a badges and status line only if I supply them. Include a section called Project status that states honestly whether the project is maintained and how to report bugs. If any command could change or delete data, put a warning before it. Provide a short example of expected output so the reader knows the installation worked. Add a contribution guide with the steps: fork, branch, test, describe the change and open a request, and a note on the code of conduct if one exists. Finish with a list of items I should check before publishing: working links, no secrets in examples, correct licence text and version numbers that match the code. Provide the same README outline in a compact form for projects with only a few commands, and tell me which parts to drop for a very small project, so the README stays proportionate to what it describes and does not hide the one command people need. Close with a short badge-free header suggestion and a table of contents only if the README exceeds 150 lines, and propose one screenshot or terminal capture that would help new users most, with the caption wording.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.