Softonic

Generador de README

Paso 1 / 4 README.md
Siguiente

Los repositorios vacíos dan una mala primera impresión. Completa el nombre del proyecto, un lema de una línea, una lista de características, el comando de instalación, un fragmento de inicio rápido, el autor y la licencia, y este generador emite un README en Markdown limpio con una jerarquía de encabezados adecuada y bloques de código delimitados: las secciones que GitHub muestra en la página de inicio de tu proyecto. Cópialo, guárdalo como README.md en la raíz de tu repositorio y haz push. Los encabezados de las secciones se escriben en inglés, la convención casi universal de los README de código abierto; tu propio texto aparece exactamente como lo escribes, en cualquier idioma.

Cómo redactar un README

  1. 1

    Añade lo básico

    Nombre del proyecto, una URL de repositorio opcional y un lema de una línea. El nombre se convierte en el título `#`; el lema se convierte en la cita debajo.

  2. 2

    Enumera las características y un inicio rápido

    Una característica por línea (cada una se convierte en una viñeta), más un breve fragmento de inicio rápido que se envuelve en un bloque de código delimitado.

  3. 3

    Instalación, licencia y autor

    El comando de instalación va en un bloque de código `bash` bajo Instalación; añade la licencia (MIT, Apache-2.0…) y una línea de autor opcional.

  4. 4

    Copia el Markdown

    Haz clic en copiar y pega la salida como `README.md` en la raíz de tu repositorio. Haz push y la versión renderizada aparecerá en la página del proyecto.

Qué contiene un buen README

La guía de estilo de GitHub y la especificación standard-readme ampliamente utilizada están de acuerdo en el orden. Coloca los elementos escaneables en la parte superior: una persona que llega a tu repositorio decide en 20 segundos si sigue leyendo.

Sección Posición Propósito
Título + lema Línea 1–2 # Proyecto seguido de una oración sobre lo que hace
Insignias Línea 3–5 Estado de CI, versión de npm, licencia, cobertura
Instalación Por encima del pliegue Un solo comando que alguien puede copiar
Uso Por encima del pliegue El fragmento mínimo viable que produce salida
API / opciones Medio Tablas de banderas, claves de configuración o puntos finales
Contribución Cerca del final Enlace a CONTRIBUTING.md, código de conducta, convenciones de PR
Licencia Última Identificador SPDX más enlace a LICENSE

Insignias que realmente ayudan

Las URL de Shields.io siguen un patrón predecible: https://img.shields.io/badge/<label>-<message>-<color>.svg. Las insignias útiles en vivo apuntan al estado de construcción, versión del paquete y conteos de descargas, no métricas de vanidad. Cuatro insignias suelen ser suficientes; más es ruido.

Errores comunes en README

  • Sin comando de instalación en la línea 1 de Instalación. Los lectores buscan npm install o pip install; si lo ocultas detrás de prosa, se irán.
  • Capturas de pantalla de 3 MB. Redimensiona a 800 px de ancho y comprime, GitHub las servirá de todos modos, pero los lectores móviles pagan el ancho de banda.
  • Insignias desactualizadas. Una insignia roja de CI le dice a los visitantes que el proyecto está roto. O arregla CI o quita la insignia.
  • Licencia faltante. Sin una licencia, tu código es “todos los derechos reservados” por defecto y las empresas no pueden usarlo.

Preguntas frecuentes

Sí. Los bloques de código delimitados, las listas con viñetas y los encabezados de estilo ATX (prefijo #) se renderizan en GitHub, GitLab y Bitbucket sin cambios. El comando de instalación se etiqueta como bloque bash; el bloque de inicio rápido se deja sin etiqueta para que tú definas el lenguaje.

Para la mayoría de los ecosistemas, README.md. Usa .rst solo si estás publicando un paquete de Python cuya documentación vive en Read the Docs y deseas que Sphinx reutilice el archivo como la página de inicio.

Cuando proporcionas una URL de repositorio, el generador añade una única insignia de licencia estática (https://img.shields.io/badge/license-<type>-blue.svg). Para insignias en vivo (estado de construcción, versión, descargas), copia un patrón de URL de shields.io y pégalo tú mismo en la salida.

No. El README se ensambla a partir de los valores del formulario y no se guarda nada. Cierra la pestaña y los datos se pierden.

Herramientas relacionadas

Referencia de la tabla ASCII

Tabla ASCII completa del 0 al 127 con decimal, hex, octal, binario y referencia numérica HTML para cada carácter, incluidos los códigos de control como NUL, LF y DEL.

Referencia de atajos de teclado

Busca los atajos predeterminados documentados de VS Code, Chrome y Bash con GNU Readline en macOS, Windows y Linux.

Generador de letras aleatorias

Genera letras aleatorias A-Z. Elige la cantidad, usa mayúsculas, minúsculas o mezcla de ambas, y aplica el resultado en juegos, consignas o clase.

Referencia de caracteres HTML

Lista buscable de entidades HTML, sus códigos nombrados y numéricos, y una copia con un clic para caracteres y símbolos especiales.

Generador de Formularios CSS

Genera el CSS de un formulario completo con estilo: una cuadrícula de formulario, etiquetas, entradas, áreas de texto, selectores y estados de foco claros. Elige el color de acento, el radio de las esquinas y la separación, y copia el código.

Generador de EditorConfig

Crea un .editorconfig con tus reglas de indentación, fin de línea y charset, y añade la sección correcta para cada lenguaje de tu repositorio: Python, Go, YAML, Makefile y más.

Herramienta disponible en otros idiomas