opensource-readme-generator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

This skill helps you generate professional, comprehensive, and visually appealing README files for open-source projects.

此技能可帮助你为开源项目生成专业、全面且视觉效果出色的README文件。

When a user asks to create or improve a README:

Analyze the Project:
- Look at the files in the current directory (using
```
ls -R
```
  or similar tools if allowed/safe) to understand the project type (Node.js, Python, Go, etc.).
- Identify key components:
```
package.json
```
  ,
```
requirements.txt
```
  , source code folders, tests.
- Determine the project name and purpose.
Gather Information:
- If the project purpose isn't clear from the code, ask the user for a brief description, "elevator pitch", or key features.
- Ask about specific sections if they are missing (e.g., "Do you have a demo link?", "What is the license?").
Use the Template:
- Read the template at
```
assets/all-star-readme-template.md
```
  .
- Use this template as the structure for your output.
- Do not just copy the template blindly. Fill in the placeholders (
```
github_username
```
  ,
```
repo_name
```
  , etc.) with real data from the project or reasonable placeholders if unknown.
- Customize the badges in the "Built With" section to match the technologies actually used in the project.
Consult Guidelines:
- Refer to
```
references/readme-guidelines.md
```
  to ensure you are meeting the "All-Star" criteria (clarity, visuals, completeness).

当用户要求创建或改进README时：

分析项目：
- 查看当前目录下的文件（若允许且安全，可使用
```
ls -R
```
  或类似工具），以了解项目类型（Node.js、Python、Go等）。
- 识别关键组件：
```
package.json
```
  、
```
requirements.txt
```
  、源代码文件夹、测试文件。
- 确定项目名称和用途。
收集信息：
- 如果从代码中无法明确项目用途，请向用户索要简要描述、「电梯游说」内容或核心功能介绍。
- 询问缺失的特定部分（例如：「你是否有演示链接？」、「项目采用什么许可证？」）。
使用模板：
- 阅读
```
assets/all-star-readme-template.md
```
  中的模板。
- 以此模板作为输出的结构框架。
- 请勿盲目复制模板。将占位符（
```
github_username
```
  、
```
repo_name
```
  等）替换为项目的真实数据，若数据未知则使用合理的占位符。
- 自定义「技术栈」（Built With）部分的徽章，使其与项目实际使用的技术匹配。
参考指南：
- 参考
```
references/readme-guidelines.md
```
  ，确保符合「全明星级」标准（清晰、可视化、内容完整）。

Understand: Read the user's request and explore the codebase to understand what the project does.
Draft: Create a draft of the
```
README.md
```
in your mind or a scratchpad, mapping project details to the template sections.
Refine: Check against
```
references/readme-guidelines.md
```
.
Output: Write the content to
```
README.md
```
(or a file specified by the user) using the
```
write_file
```
tool.

Badges: Always include badges. They make the repo look active and professional.
Visuals: If you can't generate a screenshot, add a placeholder like
```
![Screenshot](path/to/screenshot.png)
```
and tell the user to replace it.
Tone: Keep the tone professional, welcoming, and helpful.

徽章： 务必包含徽章。它们会让仓库看起来更活跃、更专业。
可视化内容： 若无法生成截图，请添加占位符，例如
```
![Screenshot](path/to/screenshot.png)
```
，并告知用户进行替换。
语气： 保持专业、友好且有帮助的语气。