name	create-readme
description	Create a README.md file for the project

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.

Task

Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Take inspiration from these readme files for the structure, tone and content:
Do not use emojis, and keep the readme concise and to the point.
Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
If you find a logo or icon for the project, use it in the readme's header.
Render callout-style blockquotes as GitHub alerts: open with [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], or [!CAUTION] on the first line, every line prefixed with >, and pick the type by intent. Reserve a plain blockquote only for a verbatim quotation — never label a quote as an alert. Only these five markers are valid on GitHub; others fall back to plain blockquotes.

name	create-readme
description	Create a README.md file for the project

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.

Task

Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Take inspiration from these readme files for the structure, tone and content:
Do not use emojis, and keep the readme concise and to the point.
Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
If you find a logo or icon for the project, use it in the readme's header.
Render callout-style blockquotes as GitHub alerts: open with [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], or [!CAUTION] on the first line, every line prefixed with >, and pick the type by intent. Reserve a plain blockquote only for a verbatim quotation — never label a quote as an alert. Only these five markers are valid on GitHub; others fall back to plain blockquotes.

create-readme

Role

Task

同仓库更多 Skills

Role

Task

同仓库更多 Skills