create-readme
Génère des fichiers README.md complets pour des projets avec une structure et un formatage professionnels. Analyse l'intégralité de l'espace de travail du projet pour créer une documentation contextuellement précise et bien organisée. Suit des modèles éprouvés de README open source avec des sections claires pour l'installation, l'utilisation et les fonctionnalités clés. Utilise la syntaxe Markdown GitHub Flavored et les admonitions pour une lisibilité et une hiérarchie visuelle améliorées. Équilibre les détails et la concision, en évitant les sections inutiles et les emojis excessifs tout en maintenant...
npx skills add https://github.com/github/awesome-copilot --skill create-readmeRole
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:
- 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
- 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.