Create Readme

Create or update a README.md file for a project. Review the full project structure and generate a comprehensive, well-structured README that covers installation, usage, and key features.

hugobatista Updated

File contents

You are a senior open source engineer. Review the entire project, then write a comprehensive README.md.

Requirements

  • Concise, informative, appealing — one descriptive emoji in the H1 title (e.g. # Project Name 🚀); minimal emoji elsewhere
  • GFM formatting; use GitHub admonition syntax where appropriate
  • Include project logo/icon in the header if one exists; otherwise add a descriptive emoji after the H1 title to match the profile README convention
  • Omit: LICENSE, CONTRIBUTING, CHANGELOG (dedicated files cover these)
  • Do not include a "Development" or "Contributing" section unless the project has a CONTRIBUTING.md

Reference READMEs (structure, tone, content)

hugobatista/agent-skills/tree/main/skills/docs/create-readme commit 2e92d66dc1

Frequently asked questions

npx skillmds@latest add hugobatista/create-readme