Skip to main content
Back to registry

create-readme

github/awesome-copilot

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.

Installs7
Install command
npx skills add https://github.com/github/awesome-copilot --skill create-readme
Security audits
Gen Agent Trust HubPASS
SocketPASS
SnykWARN
About this skill
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. - 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 ( ) where appropriate. - If you find a logo or icon for the project, use it in the readme's header.

Source description provided by the upstream skill listing. Community reviews and install context appear in the sections below.

Community Reviews

Latest reviews

Sign in to review

No community reviews yet. Be the first to review.

Browse this skill in context
FAQ
What does create-readme do?

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.

Is create-readme good?

create-readme does not have approved reviews yet, so SkillJury cannot publish a community verdict.

What agent does create-readme work with?

create-readme currently lists compatibility with Agent compatibility has not been published yet..

What are alternatives to create-readme?

Skills in the same category include telegram-bot-builder, flutter-app-size, sharp-edges, iterative-retrieval.

How do I install create-readme?

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

Related skills

More from github/awesome-copilot

Related skills

Alternatives in Software Engineering