Coding & Refactoringlow risk

create-readme

Create a README.md file for the project

github/awesome-copilot·skills/create-readme/SKILL.md

90/ 100质量分

↓

导入这个 Skill

选择你的 coding agent，复制项目级或个人级安装命令。

固定到平台收录的 commit

导入当前项目.agents/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a codex -y

导入个人环境~/.agents/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a codex -g -y

手动放置目录.agents/skills/create-readmeOfficial docs ↗

导入当前项目.claude/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a claude-code -y

导入个人环境~/.claude/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a claude-code -g -y

手动放置目录.claude/skills/create-readmeOfficial docs ↗

导入当前项目.agents/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a github-copilot -y

导入个人环境~/.copilot/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a github-copilot -g -y

手动放置目录.agents/skills/create-readmeOfficial docs ↗

导入当前项目.agents/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a cursor -y

导入个人环境~/.cursor/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a cursor -g -y

手动放置目录.agents/skills/create-readmeOfficial docs ↗

导入当前项目.agents/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a gemini-cli -y

导入个人环境~/.gemini/skills/create-readme

npx skills add https://github.com/github/awesome-copilot/tree/0aaced533251f5b86c69dfbc5e55db74c4b4d1af/skills/create-readme -a gemini-cli -g -y

Native Gemini CLIgemini skills install https://github.com/github/awesome-copilot.git --scope workspace --path skills/create-readme

手动放置目录.agents/skills/create-readmeOfficial docs ↗

⚠ 安装命令使用开源 skills CLI。执行前请检查来源、脚本和权限。

Skill 指令

在 GitHub 查看原始文件 ↗

## 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:
   - https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
   - https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
   - https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
   - https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
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.