Claude Skill

create-readme

Create a README.md file for the project

LLM Mart · 0 points · 9 0 0

Virus-scanned Reviewed automatically before listing.

Full trust report

Download gulajavaministudio-awesome-copilot-id-supplementary-skill_create-readme-266fa5a.zip · 0 KB

gulajavaministudio/awesome-copilot-id 79 14 forks MIT Updated 13d ago

Part of gulajavaministudio/awesome-copilot-id — 44 skills

Install

skills CLI npx skills add https://github.com/GulajavaMinistudio/awesome-copilot-id/tree/main/supplementary-skill/create-readme

Claude Code

claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install gulajavaministudio-awesome-copilot-id@llmmart

Git git clone https://github.com/GulajavaMinistudio/awesome-copilot-id.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole gulajavaministudio/awesome-copilot-id collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

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.

Files (awesome-copilot-id)

SKILL.md 1.3 KB

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

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:
   - 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
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.