Escribe un README o un registro de cambios en minutos

Rellena un breve formulario y obtén un README.md ordenado con los pasos de instalación, el uso, la configuración y la licencia, o un CHANGELOG.md en el formato Keep a Changelog. Mira el resultado mientras escribes. Todo se escribe en tu navegador y nada de lo que escribes se sube. Es gratis.

Cómo crear un README, paso a paso

1. Elige README.md arriba.
2. En Sobre el proyecto, escribe el Nombre del proyecto, un Resumen de una línea, una Descripción y las Funciones y Requisitos, uno por línea.
3. En Instalar y usar, elige un Gestor de paquetes como npm, pip o Cargo, añade la URL del repositorio y escribe tu Uso. Elige el Lenguaje del uso para que el código se formatee correctamente.
4. Añade comandos de Ajustes y Desarrollo si corresponden.
5. Elige una Licencia y un Titular de los derechos de autor, y activa el Índice, la Insignia de licencia o la sección Contribuir según haga falta.
6. Pulsa Copiar Markdown o Descargar README.md.

Qué hace bueno a un README

Di en una línea qué hace el proyecto y luego muestra cómo instalarlo y el ejemplo más pequeño que funcione. Los lectores deciden en segundos si un proyecto les sirve, así que lo siguiente son las funciones y los requisitos, seguidos de los ajustes, los comandos de desarrollo, cómo contribuir y la licencia. Las secciones que dejes vacías se omiten.

Registros de cambios que la gente puede leer

El registro de cambios sigue Keep a Changelog: primero la versión más reciente, cada una con una fecha y sus cambios agrupados en Añadido, Cambiado, Obsoleto, Eliminado, Corregido y Seguridad. Mantén una sección Unreleased arriba para los cambios que aún no se han publicado. Con una dirección de repositorio, cada versión enlaza con la comparación con la anterior. Puedes añadir una versión anterior a mano, o crear entradas a partir de mensajes de commit.

Consejos

• Pon cerca del principio un comando de instalación que funcione y un breve ejemplo de uso.
• Indica la licencia con claridad para que otros sepan cómo pueden usar tu código.
• Haz que la descripción cuente lo que hace el proyecto para el lector, no cómo lo construiste.
• Actualiza el registro de cambios con cada versión, no solo al final.

Para mantener secretos y archivos de compilación fuera de un repositorio, usa el generador de gitignore y el generador de ejemplos de env.

Preguntas

¿Puedo partir de mi historial de commits?

Sí. Pega la salida de git log --oneline en A partir de mensajes de commit. Los commits escritos como feat:, fix:, perf: y así sucesivamente se ordenan en los grupos correspondientes, y los cambios incompatibles marcados con un signo de exclamación se etiquetan. Edita después la redacción; los mensajes de commit se escriben para desarrolladores y los registros de cambios, para usuarios.

¿Añade el texto de la licencia?

Añade una sección License que nombra la licencia y apunta a un archivo LICENSE. Pon el texto completo de la licencia en ese archivo; la página oficial de la licencia lo tiene.

¿Dónde van los archivos?

Descargar guarda README.md o CHANGELOG.md en tu dispositivo. Ponlo en el nivel superior de tu repositorio y los sitios de alojamiento de código lo mostrarán en la página del proyecto.

¿Qué licencias puedo elegir?

MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, ISC, MPL 2.0, Unlicense o Todos los derechos reservados, o deja la sección fuera.