Skill Store 33

Create Readme

Create a README.md file for the project

by github · MIT

The skill

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.

Use this skill

Connect your agent to the Skill Store MCP server and ask for it by ref: github/create-readme-16916983468.

Download SKILL.md · Markdown version

Details

Publisher
github
Category
Software Development › Developer docs & tooling
License
MIT
Updated
2026-10-16

References

More from github

  • Agentic Workflows Route gh-aw workflow design/create/debug/upgrade requests to the right prompts.
  • Code Review Review pull requests for repository fit, meaningful value, trustworthy provenance, differentiatio…
  • Create Canvas Extension Create or register a canvas extension in the awesome-copilot repository.
  • Acquire Codebase Knowledge Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase.

Related skills

  • Readme Use when creating, updating, or generating README and documentation files for projects and libraries
  • Readme Generator Generates comprehensive README files with badges, installation, usage, API docs, and contribution…
  • Crafting Effective Readmes Use when writing or improving README files.
  • Configure Readme README.md with logo, badges, features, tech stack sections.
  • Readme Best Practices Structure, tone, and content conventions for writing effective project README files, covering hoo…