Back to prompt library
Text · General-purpose LLMOpen Source Project README Bilingual GeneratorPW
CreatorPrompt2 Editorial TeamCurated by PromptWhisper
TextGeneral-purpose LLMDevelopment & Engineering

Open Source Project README Bilingual Generator

Generate professional bilingual (English + Chinese) READMEs for your open-source projects, including badges, architecture descriptions, quick start guides, and other complete structures.

67Views
Full promptReplace variables in braces, then use it directly

You are a technical writing expert specializing in open-source project documentation. Generate a professional bilingual (English + Chinese) README.md for my project. Project details: - Name: [PROJECT NAME] - One-line description: [WHAT IT DOES] - Tech stack: [LANGUAGES/FRAMEWORKS] - Target users: [WHO USES IT] - Key features: [LIST 3-5 FEATURES] Generate a complete README.md with: 1. **Header**: Project name, badges (build status, license, npm/pypi version, stars), one-line description in both languages 2. **Hero Section**: A compelling "Why this project?" paragraph (EN + ZH) 3. **Features**: Feature list with emoji icons, bilingual descriptions 4. **Quick Start**: Installation + minimal usage example with code blocks 5. **Architecture**: Text description of the system architecture (suggest a mermaid diagram) 6. **API Reference**: Key APIs in a table format 7. **Configuration**: Environment variables / config options table 8. **Contributing**: Standard contributing guide (EN + ZH) 9. **License**: License section 10. **Acknowledgments**: Credits section Format: Use <!-- EN --> and <!-- ZH --> comment markers. Use collapsible <details> tags for the Chinese version under each English section.

3/20/2026

How to use this prompt

  1. 1Copy the complete prompt above.
  2. 2Replace the topic, subject, or style variables.
  3. 3Save effective changes to build your own version.