Generador de README
Rellena unos cuantos campos y obtén un README.md bien estructurado para GitHub, GitLab o npm: insignias, índice, instalación, uso, configuración, hoja de ruta, cómo contribuir, licencia y colaboradores. Mira la vista previa renderizada mientras escribes y luego cópialo o descárgalo.
Última actualización:
Datos básicos del proyecto
Insignias
Descripción y funciones
Instalación y uso
Hoja de ruta y contribuciones
Licencia, colaboradores y contacto
Cómo usar Generador de README
- Introduce los datos básicos del proyecto: nombre, eslogan de una línea y, si quieres, el repositorio de GitHub (usuario/repo) y el nombre del paquete. Con ellos se generan las insignias y los comandos de instalación.
- Elige las insignias, como licencia, estado de compilación o versión de npm, y elige un estilo de insignia.
- Describe el proyecto: qué hace, sus funciones principales, y añade una captura de pantalla o un enlace a la demo.
- Rellena la instalación y el uso: elige un gestor de paquetes para rellenar los comandos y pega un ejemplo de código breve.
- Añade el resto: opciones de configuración, hoja de ruta, licencia y colaboradores. Las secciones vacías se omiten automáticamente.
- Revisa la vista previa y luego copia el Markdown o descarga README.md en la raíz de tu repositorio.
Estructura recomendada del README
| Sección | Qué escribir | ¿Necesaria? |
|---|---|---|
| Título y descripción | El nombre del proyecto y una frase sobre qué hace y para quién | Siempre |
| Insignias | Estado de compilación, versión, licencia: señales rápidas de buena salud y madurez | Recomendada |
| Descripción / captura | El problema que resuelve, una captura o un GIF, un enlace a la demo | Recomendada |
| Primeros pasos | Requisitos previos y los comandos de instalación exactos | Siempre en proyectos de código |
| Uso | El ejemplo más pequeño que funcione al copiarlo y pegarlo | Siempre en proyectos de código |
| Configuración | Variables de entorno u opciones, con sus valores predeterminados | Si es configurable |
| Hoja de ruta | Lo que está hecho y lo que está previsto (GitHub muestra las casillas de las listas de tareas) | Opcional |
| Cómo contribuir | Cómo proponer cambios; enlaza a CONTRIBUTING.md para guías largas | En proyectos open source |
| Licencia | El nombre de la licencia y un enlace al archivo LICENSE | Siempre en proyectos open source |
| Colaboradores, agradecimientos, contacto | Créditos y cómo contactar con los responsables | Opcional |
Referencia rápida de Markdown de GitHub
| Elemento | Markdown |
|---|---|
| Encabezado | ## Installation |
| Negrita / cursiva | **negrita**, *cursiva* |
| Código en línea | `npm test` |
| Bloque de código con resaltado | ```js … ``` |
| Enlace / imagen | [texto](https://…),  |
| Insignia con enlace | [](https://…) |
| Lista de tareas | - [x] hecho, - [ ] pendiente |
| Tabla | | A | B | y después | --- | --- | |
| Bloque centrado | <p align="center">…</p> (se admite HTML) |
| Nota destacada | > [!NOTE] en la primera línea de una cita |
Consejos para un README que la gente realmente lea
- Empieza por el valor. Las dos primeras líneas deben decirle al visitante qué hace el proyecto y por qué lo usaría.
- Haz que el primer ejemplo funcione al copiarlo y pegarlo. Prueba los comandos de instalación y uso en un entorno limpio.
- Muestra, no cuentes. Una captura o un GIF corto explica una interfaz más rápido que varios párrafos.
- Usa rutas relativas para las imágenes y los archivos del repositorio (
docs/screenshot.png) para que funcionen en forks y ramas. - Mantenlo al día. Actualiza el README en el mismo pull request que cambie la instalación o el uso.
Preguntas frecuentes
¿Qué debe incluir un buen README?
Como mínimo: el nombre del proyecto, una descripción de una frase, cómo instalarlo, un ejemplo de uso breve y la licencia. Los proyectos más grandes añaden insignias, capturas de pantalla, opciones de configuración, una hoja de ruta, pautas para contribuir y créditos.
¿Dónde pongo el README.md?
En la carpeta raíz de tu repositorio. GitHub, GitLab y Bitbucket lo muestran automáticamente en la página principal del proyecto, y npm muestra el README de un paquete publicado.
¿Cómo funcionan las insignias?
Las insignias son imágenes servidas por shields.io. Las insignias dinámicas, como las de estrellas, licencia o estado de compilación, leen datos en vivo de GitHub, npm o PyPI cada vez que se ve el README, así que necesitan el usuario/repo o el nombre del paquete correctos. Solo aparecen cuando el repositorio o el paquete es público.
¿Por qué funcionan en GitHub los enlaces del índice?
GitHub crea un ancla para cada encabezado pasándolo a minúsculas, quitando la puntuación y sustituyendo los espacios por guiones. El generador crea el índice con la misma regla, así que #getting-started salta al encabezado Getting Started.
¿El README incluye el texto completo de la licencia?
No. El README indica el nombre de la licencia y remite a un archivo LICENSE, que es lo habitual. Crea ese archivo por separado, por ejemplo con un generador de licencias.
¿Se sube la información de mi proyecto?
No. El README se genera en tu navegador y el borrador solo se guarda en el almacenamiento local. Las imágenes de las insignias de la vista previa se cargan desde shields.io igual que lo harían en GitHub.
¿Se prueban todas las herramientas de FreeToolCabin para comprobar su calidad y precisión?
Sí. Cada herramienta del sitio pasa pruebas automáticas en navegadores reales para comprobar que el resultado es correcto y que no hay errores. Si encuentras un fallo o tienes una sugerencia, escríbenos a [email protected] y lo revisaremos.