hu3rror/my-skills

create-readme

Create a README.md file for the project

Ver código fuente

Cómo usar

  1. Copia el comando y revisa el paquete antes de instalarlo en tu entorno de agente.
  2. Consulta las herramientas, credenciales y entornos necesarios en el documento original.
  3. Describe las entradas y el resultado deseado; contrasta la salida con las fuentes.
npx skills add https://github.com/hu3rror/my-skills --skill create-readme

Antes de empezar

  • La instalación no incluye suscripción al modelo, cuota API ni permisos sobre tus archivos.
  • Las estrellas e instalaciones reflejan actividad, no una prueba independiente de calidad o seguridad.
Documento original del Skill

Contenido del repositorio de origen con títulos, ejemplos, código, tablas, enlaces e imágenes preservados.

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 examples (local copies in references/ alongside this skill — read the ones closest to the project's type, not all of them) for the structure, tone and content:
  1. Do not overuse emojis, and keep the readme concise and to the point.
  2. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  3. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  4. If you find a logo or icon for the project, use it in the readme's header.
  5. Write the README in English by default. Determine whether this is a personal repository (its remote owner matches gh api user --jq .login; treat it as external if it can't be confirmed). If personal, also write a README_zh-CN.md: a Chinese re-organization of the English README — same technical facts, scope, usage steps, and key limitations, not a sentence-by-sentence translation — and cross-link the two files.
del mismo repositorio

Más Skills

Todos los Skills