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,754
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
claudeCursorWindsurf+1intermediate
167
48
875
Rédacteur de documentation KDoc
Documentation
Rédige une documentation KDoc concise pour les classes et fonctions Kotlin, avec des résumés courts sans métadonnées ni documentation de variables. Utile lors de l'ajout de KDoc à des fichiers Kotlin en suivant des règles qui excluent les membres privés ou évidents.
Claude CodebeginnerSûr 2
0
0
139