Generador de README.md
Rellena un formulario corto y obtén un README.md limpio para GitHub con insignias, instalación, uso, características, contribución y licencia, más vista previa.
propietario/repo; se usa para las insignias y el comando git clone.
Una característica por línea.
Los títulos de sección se escriben en inglés, la convención habitual en READMEs de código abierto. Tu propio texto se mantiene tal como lo escribiste.
Herramientas Relacionadas
Ver Todas¿Qué es Generador de README?
Un README es el primer archivo que se lee en un repositorio. Esta herramienta convierte unos pocos campos —nombre del proyecto, descripción, características, comandos de instalación y uso, licencia y autor— en un README.md bien estructurado con insignias opcionales de shields.io, un índice y una guía de contribución. Puedes alternar entre el código Markdown y una Vista previa renderizada.
Cómo usar Generador de README
- Introduce el Nombre del proyecto y, si está en GitHub, el Repositorio de GitHub como
owner/repo. - Añade un Lema de una línea, la Descripción, las Características (una por línea), el Comando de instalación y el Ejemplo de uso.
- Elige una Licencia, añade el Autor y activa o desactiva las insignias, el Índice y la Sección de contribución.
- Revisa la Vista previa y luego copia o descarga README.md.
Ejemplo
Nombre del proyecto tiny-cache, lema "A 1 KB LRU cache", repositorio acme/tiny-cache, licencia MIT
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Cuándo usar Generador de README
Úsalo para empezar en un minuto el README de una librería, CLI, proyecto personal o repositorio interno nuevo, y luego pule el texto a mano. Genera un esqueleto razonable, no documentación: aún tienes que explicar la configuración, los detalles de la API y los ejemplos propios de tu proyecto.
Cómo funciona Generador de README
El formulario se convierte en Markdown con sabor GitHub: un H1 con el nombre, insignias opcionales (licencia, estrellas e issues de img.shields.io, enlazadas al repositorio), un lema en forma de cita y luego secciones de Features, Installation (con un bloque git clone + cd si hay repositorio), Usage (un bloque de código en el lenguaje que elijas), Contributing, License y Author. Los enlaces del índice siguen las reglas de anclas de encabezados de GitHub. La vista previa se renderiza con marked y se sanea con DOMPurify.
Casos de Uso Comunes
- Arrancar el README de un nuevo paquete de código abierto
- Estandarizar la estructura de los README en los repositorios del equipo
- Añadir rápidamente secciones de licencia y contribución
- Crear un README para un proyecto de portafolio o de hackathon
Preguntas Frecuentes
¿También crea el archivo LICENSE?
No. Añade una sección License que enlaza a LICENSE; añade el texto de la licencia a tu repositorio (GitHub puede crearlo por ti).
¿Por qué los encabezados están en inglés?
Los encabezados de sección en inglés son la convención en los README de código abierto y facilitan que colaboradores de todo el mundo recorran el proyecto. Tu propio texto queda en el idioma en que lo escribas.
¿Las insignias funcionan con repositorios privados?
Shields.io no puede leer repositorios privados de GitHub, así que las insignias de estrellas e issues solo muestran datos de repositorios públicos.