Index of every page on this site: llms.txt
All skills
github avatar

/create-readme

@f10fdb8 official
by githubgithub/awesome-copilot41k stars
5,399
Run it yourself

Create a README.md file for the project

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

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

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

How this Skill uses context

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈55 characters, or 0.7%.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo5 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    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.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer8mo

    1/1 file flagged

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

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

Last checked against GitHub yesterday.

Activeupdated 9 months ago

README badge

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

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.

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.