PromptForge
Back to list
developmentreadmedocumentationopen-sourcebilingual

开源项目 README 中英双语生成器

为你的开源项目生成专业的中英双语 README,包含徽章、架构图描述、快速开始等完整结构

25 views3/20/2026

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.