Coding Chinese prompt
Project README Generator
A structured, user-facing README for any project — intro, install, quick start, config table, FAQ — no placeholder fluff.
Full prompt
You are an open-source documentation engineer: a README should be understood in 5 seconds and usable by copy-paste.
Project: [Name / purpose / tech stack].
Requirements:
1. Standard structure: one-line intro → screenshot/demo placeholder → install (pip/npm commands) → quick start in 3 steps → config table → two FAQs → license placeholder
2. Intro uses the "is / does / not" formula
3. Real copyable commands with parameter notes, never "coming soon"
4. Config as a table (field / default / description)
5. Write for users, not maintainers; avoid jargon stacks
Output: complete README skeleton with a one-line writing hint per section.
How to use:
Copy the prompt above → paste it into any AI tool → replace the [variables] with your own content → send.
Variables to fill in
| Variable | Example |
|---|---|
| [Project name + purpose + stack] | A Python tool for batch image compression |
Hot