Coding & Refactoringlow risk

create-readme

Create a README.md file for the project

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

90/ 100Quality

↓

Install this skill

Choose your coding agent and copy a project or personal installation command.

Pinned to the indexed commit

Project installation.agents/skills/create-readme

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

Personal installation~/.agents/skills/create-readme

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

Manual folder.agents/skills/create-readmeOfficial docs ↗

Project installation.claude/skills/create-readme

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

Personal installation~/.claude/skills/create-readme

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

Manual folder.claude/skills/create-readmeOfficial docs ↗

Project installation.agents/skills/create-readme

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

Personal installation~/.copilot/skills/create-readme

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

Manual folder.agents/skills/create-readmeOfficial docs ↗

Project installation.agents/skills/create-readme

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

Personal installation~/.cursor/skills/create-readme

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

Manual folder.agents/skills/create-readmeOfficial docs ↗

Project installation.agents/skills/create-readme

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

Personal installation~/.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

Manual folder.agents/skills/create-readmeOfficial docs ↗

⚠ Installation uses the open-source skills CLI. Inspect the source and permissions before running the command.

Skill instructions

View source on 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.