AcademyReglasDesarrollo

Reglas para escribir README

Equipos de desarrollo y producto que publican código o herramientas y quieren que Cursor redacte README claros y fáciles de recorrer.

  • Recomendadonuestra valoración
  • 40.892estrellas del repositorio
  • CC0-1.0licencia
  • hace 4 mesesúltima actualización

Úsalo ahora

mkdir -p .cursor/rules && curl -fsSL https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules/readme-best-practices-cursorrules-prompt-file.mdc -o .cursor/rules/readme-best-practices.mdc
readme-best-practices.mdc

Cargando el archivo...

Qué hace

Un archivo de reglas para Cursor para escribir README de proyecto que se lean como una landing page. Pide una frase inicial clara, un ejemplo funcional al principio, tablas en lugar de listas largas, un inicio rápido para copiar y pegar y un lenguaje sencillo sin jerga de marketing.

Casos de uso

  1. 01Redactar el README de un repositorio nuevo
  2. 02Reescribir un README largo para que sea más ágil
  3. 03Escribir una sección de inicio rápido

Preguntas sobre
Reglas para escribir README.

¿Para qué sirve Reglas para escribir README?

Equipos de desarrollo y producto que publican código o herramientas y quieren que Cursor redacte README claros y fáciles de recorrer. Un archivo de reglas para Cursor para escribir README de proyecto que se lean como una landing page. Pide una frase inicial clara, un ejemplo funcional al principio, tablas en lugar de listas largas, un inicio rápido para copiar y pegar y un lenguaje sencillo sin jerga de marketing.

¿Cómo instalo Reglas para escribir README?

Ejecuta en tu terminal: mkdir -p .cursor/rules && curl -fsSL https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules/readme-best-practices-cursorrules-prompt-file.mdc -o .cursor/rules/readme-best-practices.mdc

¿Reglas para escribir README es de código abierto?

Sí. El código está publicado en GitHub (PatrickJS/awesome-cursorrules) con licencia CC0-1.0.

¿Es seguro usar Reglas para escribir README?

Superó nuestro análisis automático de robo de credenciales, instrucciones ocultas y comandos de instalación peligrosos. Software de código abierto de terceros. Sabemos AI no lo mantiene. Revisa el código y los permisos antes de conectarlo a datos de la empresa.