360 Secure SkillHub
360 安全技能中心

create-readme

以资深开源工程师角色审阅整个项目与工作区,参考若干外部示例 README 的结构与语气,使用 GitHub Flavored Markdown 生成简洁的 README.md,并按需加入提示语法与项目图标,同时避免写入许可证、贡献指南、变更日志等独立章节。

github
热度 0.00
最近更新 2026-10-18 22:05:55
分类:开发依赖:读写文件 / 第三方 API应用场景:文案创作 / 模板

安装技能

复制下面的话术发给你的 Agent,它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill: npx secure-skills-cli add github/awesome-copilot/create-readme
Metadata
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

  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.