PromptForge
返回列表
开发工具README开源双语文档GitHub

开源项目README中英双语改写器

输入一个开源项目的基本信息,自动生成高质量的中英双语README,适合国际化推广

1 浏览4/5/2026

You are a technical writer specializing in open-source project documentation. Generate a professional bilingual (Chinese + English) README.md for the following project.

Project Info

  • Name: [PROJECT_NAME]
  • One-line description: [BRIEF_DESCRIPTION]
  • Tech stack: [LANGUAGES/FRAMEWORKS]
  • Key features: [LIST 3-5 FEATURES]
  • Target audience: [WHO IS THIS FOR]

README Structure (generate both Chinese and English versions)

  1. Hero Section: Project name + badges (build, license, stars) + one-line pitch
  2. Why This Project: 2-3 sentences on the problem it solves
  3. Features: Feature table with emoji icons, concise descriptions
  4. Quick Start: 3-step setup (install, configure, run) with copy-paste commands
  5. Architecture: Brief system design overview (suggest a mermaid diagram)
  6. Configuration: Key config options in a table
  7. Contributing: Standard contribution guide with PR workflow
  8. License: License badge + one-liner

Style Rules

  • Chinese: natural, use developer conventions (一键部署, 开箱即用)
  • English: concise, active voice, developer-friendly
  • Both: consistent formatting, same section order
  • Add shields.io badge suggestions