create-readme

Erstellt umfassende README.md-Dateien für Projekte mit professioneller Struktur und Formatierung. Analysiert den gesamten Projektarbeitsbereich, um kontextuell genaue, gut organisierte Dokumentation zu erstellen. Folgt bewährten Open-Source-README-Mustern mit klaren Abschnitten für Einrichtung, Nutzung und Hauptfunktionen. Verwendet GitHub Flavored Markdown und Admonition-Syntax für verbesserte Lesbarkeit und visuelle Hierarchie. Balanciert Detailgenauigkeit mit Prägnanz, vermeidet unnötige Abschnitte und übermäßige Emojis, während...

npx skills add https://github.com/github/awesome-copilot --skill create-readme

ZIP herunterladen 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

Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Take inspiration from these readme files for the structure, tone and content:
Do not overuse emojis, and keep the readme concise and to the point.
Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
If you find a logo or icon for the project, use it in the readme's header.

Mehr Skills von github

console-rendering

Anleitung zur Verwendung des auf struct-Tags basierenden Konsolen-Rendering-Systems in Go

acquire-codebase-knowledge

Verwenden Sie diese Fähigkeit, wenn der Benutzer explizit darum bittet, eine bestehende Codebasis zu kartieren, zu dokumentieren oder sich in sie einzuarbeiten. Auslöser für Aufforderungen wie „diese Codebasis kartieren“, „dokumentieren…

acreadiness-assess

Run the AgentRC readiness assessment on the current repository and produce a static HTML dashboard at reports/index.html. Wraps `npx github:microsoft/agentrc…

acreadiness-generate-instructions

Generieren Sie maßgeschneiderte KI-Agenten-Anweisungsdateien über den AgentRC-Befehl. Erstellt .github/copilot-instructions.md (Standard, empfohlen für Copilot in VS…

acreadiness-policy

Helfen Sie dem Benutzer, eine AgentRC-Richtlinie auszuwählen, zu schreiben oder anzuwenden. Richtlinien passen die Bereitschaftsbewertung an, indem sie irrelevante Prüfungen deaktivieren, Auswirkungen/Stufen überschreiben, festlegen…

add-educational-comments

Füge pädagogische Kommentare zu Codedateien hinzu, um sie in effektive Lernressourcen zu verwandeln. Passt Erklärungstiefe und Ton an drei konfigurierbare Wissensstufen an: Anfänger, Fortgeschrittene und Fortgeschrittene. Fordert automatisch eine Datei an, falls keine bereitgestellt wird, mit nummerierter Liste für schnelle Auswahl. Erweitert Dateien um bis zu 125 % nur durch pädagogische Kommentare (hartes Limit: 400 neue Zeilen; 300 bei Dateien über 1.000 Zeilen). Bewahrt Dateikodierung, Einrückungsstil, Syntaxkorrektheit und...

adobe-illustrator-scripting

Schreiben, debuggen und optimieren Sie Adobe Illustrator-Automatisierungsskripte mit ExtendScript (JavaScript/JSX). Verwenden Sie dies beim Erstellen oder Ändern von Skripten, die…

agent-governance

Deklarative Richtlinien, Intent-Klassifizierung und Prüfpfade zur Kontrolle des Zugriffs und Verhaltens von KI-Agenten-Tools. Zusammensetzbare Governance-Richtlinien definieren erlaubte/blockierte Tools, Inhaltsfilter, Ratenbegrenzungen und Genehmigungsanforderungen – gespeichert als Konfiguration, nicht als Code. Semantische Intent-Klassifizierung erkennt gefährliche Eingabeaufforderungen (Datenerfassung, Privilegieneskalation, Prompt-Injection) vor der Tool-Ausführung mittels musterbasierter Signale. Der Governance-Decorator auf Tool-Ebene setzt Richtlinien bei Funktionen durch...