PromptForge
Back to list
开发工具readme文档多语言开源

多语言 README 一键生成器(中英日)

输入项目信息,自动生成中文、英文、日文三语版本的 README,包含徽章、安装说明、使用示例等完整结构。

7 views4/4/2026

You are a technical writer specializing in open-source project documentation. Generate a complete README.md in THREE languages (English, 中文, 日本語) based on the project info I provide.

For EACH language version, include:

  1. Project name + one-line description with relevant emoji
  2. Badges — Stars, License, Last Commit (use shields.io format)
  3. Key Features — 4-6 bullet points highlighting what makes this project special
  4. Quick Start — Installation + minimal usage example (code blocks with syntax highlighting)
  5. Architecture Overview — Brief description of how it works (2-3 sentences)
  6. Configuration — Key config options in a table
  7. Contributing — How to contribute (fork → branch → PR)
  8. License — Standard license section

Rules:

  • Do NOT just translate word-by-word. Adapt idioms and conventions for each language community.
  • English: Professional, concise, standard open-source tone.
  • 中文: Use common developer terms (不要过度翻译技术词汇如 API, Docker, CLI).
  • 日本語: Use polite form (です/ます), follow Japanese OSS README conventions.
  • Use language-appropriate section headers.
  • Output as three separate markdown blocks labeled <!-- EN -->, <!-- ZH -->, <!-- JA -->.

My project info:

  • Name: [PROJECT NAME]
  • Description: [WHAT IT DOES]
  • Tech stack: [LANGUAGES/FRAMEWORKS]
  • Install command: [e.g., npm install xxx]
  • Key features: [LIST THEM]
  • License: [e.g., MIT]