skilld
All skills
github avatar

/create-readme

@caab1f6 official
by githubgithub/awesome-copilot40k stars
5,040

Create a README.md file for the project

Ask your Agent

Use this Skill: https://skilld.dev/gh/github/awesome-copilot/create-readme

This session only. Nothing lands on disk.

SKILL.md

≈14 tokens always: the name and description. ≈312 when used: this file.

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.

Source: SKILL.md on GitHub

Third-party checks

1 warning16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    The skill is safe but includes a minor risk of indirect prompt injection because it reads and processes content from external GitHub URLs and local workspace files.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer7mo

    1/1 file flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at caab1f6. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 19 hours ago.

Activeupdated 7 months ago

Topics

README badge

README badge for github/awesome-copilot/create-readme

What it does

Writes a comprehensive README.md for a project by analyzing its codebase and structure, then generating a well-organized document with sections for overview, setup, usage, and examples. The skill follows a curated style guide and avoids boilerplate sections like LICENSE or CONTRIBUTING.

Generated from the current SKILL.md.

Frequently asked

Does this skill generate a README from scratch or edit an existing one?
It generates a comprehensive README.md file by reviewing the entire project and workspace. If a README already exists, the skill will create a new one based on the project structure.
What sections does the generated README include?
The skill creates a well-structured README with sections like overview, features, and usage, inspired by open source best practices. It excludes LICENSE, CONTRIBUTING, and CHANGELOG sections, which are handled separately.
Can I customize the tone or structure of the generated README?
The skill follows a specific tone and structure based on reference READMEs from Azure samples and other projects. It prioritizes conciseness and readability over customization, and limits emoji usage.
Does this skill add a project logo or icon to the README?
Yes. If the skill finds a logo or icon for the project, it will include it in the README's header.

Generated from the current SKILL.md. These answers refresh after source changes.