Generador de README de GitHub
Crea un README.md profesional para tu proyecto de GitHub: insignias, acerca de, funciones, stack tecnológico, instalación, uso, variables de entorno, hoja de ruta, contribución, licencia y autor.
Cargando Generador de README de GitHub…
Tus archivos nunca salen de tu dispositivo
Cómo usar Generador de README de GitHub
- 1
Abre Generador de README de GitHub en esta página. Se carga directamente en tu navegador.
- 2
Añade tu archivo, texto o valores y ajusta la configuración.
- 3
Copia o descarga el resultado. No se sube ni se guarda nada.
Acerca de esta herramienta
El README es la portada de cada repositorio: lo primero que leen visitantes, reclutadores y colaboradores. Este generador de README de GitHub crea un README.md completo y bien estructurado a partir de un formulario corto. Rellena los datos del proyecto, activa o desactiva secciones, elige tu stack tecnológico y copia el Markdown o descarga el archivo. Tu borrador se guarda en el navegador mientras trabajas.
Cómo crear un README
- Escribe el nombre del proyecto, el lema y la descripción.
- Añade tu repositorio de GitHub (user/repo) para generar insignias, y una URL de demo si la tienes.
- Elige las secciones que quieres incluir y las tecnologías de tu stack.
- Elige una licencia: MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 o Unlicense, y añade el autor.
- Revisa la vista previa y copia el Markdown o descarga README.md.
Secciones que puedes incluir
- Insignias de shields.io: estrellas, licencia y más.
- Acerca de y funciones: qué hace el proyecto y por qué.
- Stack tecnológico: los lenguajes y frameworks usados.
- Instalación y uso con bloques de código.
- Variables de entorno necesarias para ejecutarlo.
- Hoja de ruta, normas de contribución, licencia y autor.
Qué hace bueno a un README
- Di qué hace en una frase justo al principio.
- Muéstralo: una captura o un GIF arriba explica más que varios párrafos.
- Haz que la instalación sea copiar y pegar: comandos exactos, en orden, que funcionen en una máquina limpia.
- Mantenlo al día cuando cambien los comandos o las opciones.
Edita el resultado en el editor de Markdown, añade tablas con el generador de tablas Markdown y consulta la sintaxis en la chuleta de Markdown.
Preguntas frecuentes
¿Qué debe incluir un README?
Qué hace el proyecto, cómo instalarlo y usarlo, el stack tecnológico, cómo contribuir y la licencia. Las insignias y una captura ayudan a entenderlo rápido.
¿Dónde pongo el archivo README?
En la raíz del repositorio, con el nombre README.md. GitHub lo muestra automáticamente en la página del repositorio.
¿Puedo añadir insignias?
Sí. Escribe tu repositorio como user/repo y el generador añade las insignias de shields.io correspondientes.
¿Qué licencias puedo elegir?
MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 y Unlicense. Añade también el archivo LICENSE completo a tu repositorio.
¿Se guarda mi borrador?
Sí, en el almacenamiento local del navegador, así que sigue ahí cuando vuelves en el mismo dispositivo.
¿Puedo crear un README de perfil?
Sí. Crea un repositorio que se llame exactamente como tu usuario y usa el README para presentarte; GitHub lo muestra en tu perfil.