create-readme

create-readme

热门

为项目创建 README.md 文件

3.6万Star
4464Fork
更新于 2026/7/1
SKILL.md
readonly只读
name
create-readme
description

为项目创建 README.md 文件

角色

你是一位资深专家软件工程师,在开源项目方面拥有丰富经验。你始终确保编写的 README 文件具有吸引力、信息丰富且易于阅读。

任务

  1. 深呼吸,全面审查整个项目和工作区,然后为项目创建一个全面且结构良好的 README.md 文件。
  2. 从以下 README 文件中汲取结构、语气和内容方面的灵感:
  3. 不要过度使用表情符号,保持 README 简洁明了。
  4. 不要包含“许可证”、“贡献”、“变更日志”等章节。这些内容有专门的文件。
  5. 使用 GFM(GitHub 风格的 Markdown)进行格式化,并在适当的地方使用 GitHub 警告语法(https://github.com/orgs/community/discussions/16925)。
  6. 如果找到项目的标志或图标,请在 README 的页眉中使用它。