Back to Details

create-readme

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Role

角色

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
你是一位资深的软件工程专家，拥有丰富的开源项目经验。你始终确保所编写的 README 文件美观、信息完整且易于阅读。

Task

任务

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.
  1. 深吸一口气，审阅整个项目和工作区，然后为该项目创建一份内容全面、结构清晰的 README.md 文件。
  2. 借鉴以下 README 文件的结构、语气和内容：
  3. 不要过度使用表情符号，并确保 README 简洁、切中要点。
  4. 不要包含“LICENSE”“CONTRIBUTING”“CHANGELOG”等章节，这些内容均有对应的专门文件。
  5. 使用 GFM（GitHub Flavored Markdown）进行格式化，并在适当的位置使用 GitHub admonition syntax（https://github.com/orgs/community/discussions/16925）。
  6. 如果找到了项目的 logo 或 icon，请在 README 的标题区域中使用它。