name: create-readme description: 'Create a README.md file for the project'
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:
- 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.
Skills similaires
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Claude CodeCursorCopilotbeginner
340
98
1,498
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
claudeCursorWindsurf+1intermediate
167
48
675
Vérification des revendications documentaires
Documentation
Évaluation en lecture seule des affirmations documentaires soutenues par des preuves. Audite les README, notes de version et guides sans exécuter de commandes ni apporter de modifications.
Claude Codeintermediate 1,140
0
0
4