HomeCasa Escribir el README de un proyecto
Crea un README claro y completo con instalación, uso, configuración y contribución a partir de la descripción de tu proyecto. Pensado para ChatGPT, Claude y Gemini. Incluye 4 variables personalizables y se copia gratis en un clic.
Principiante · Código · Pendiente de revisión editorial
Prompt
Actúa como redactor técnico con experiencia en proyectos de código abierto.
Escribe el README.md del proyecto {{nombre}}.
Descripción: {{descripcion}}
Tecnologías: {{tecnologias}}
Público del README: {{publico}}
Incluye estas secciones en Markdown:
1. Título y descripción en una frase.
2. Características principales (máx. 6 viñetas).
3. Requisitos previos.
4. Instalación paso a paso con bloques de comandos.
5. Configuración (variables de entorno en una tabla: nombre, descripción, obligatoria, ejemplo).
6. Uso con un ejemplo mínimo.
7. Estructura de carpetas resumida.
8. Cómo contribuir y licencia: usa [LICENCIA] si no la indico.
Usa frases cortas, voz activa y evita la jerga innecesaria. No inventes comandos que no se deduzcan de las tecnologías indicadas: márcalos como [VERIFICAR].Cómo usarlo
Pega también tu package.json, composer.json o requirements.txt para que los comandos sean exactos.
Ejemplo de uso
Proyecto: API de reservas en Node.js con PostgreSQL para un gimnasio.
Resultado de ejemplo
# TaskFlow
Gestor de tareas colaborativo con tableros kanban que puedes alojar en tu propio servidor.
Funcionalidades
- Tableros kanban con columnas personalizables.
- Tareas con responsables, etiquetas y fechas límite.
- Colaboración en equipo con permisos por tablero.
- API REST para integraciones.
Requisitos previos
- Node.js [VERIFICAR versión mínima]
- PostgreSQL [VERIFICAR versión mínima]
- npm
Instalación
git clone [URL_DEL_REPOSITORIO] taskflow
cd taskflow
npm install
cp .env.example .env # [VERIFICAR] nombre del archivo de ejemplo
npm run migrate # [VERIFICAR] script de migraciones
npm run devConfiguración
| Variable | Descripción | Obligatoria | Ejemplo |
|---|---|---|---|
DATABASE_URL | Conexión a PostgreSQL | Sí | postgres://user:pass@localhost:5432/taskflow |
PORT | Puerto de la API Express | No | 3000 |
JWT_SECRET | Clave para firmar sesiones [VERIFICAR] | Sí | cambia-esto |
Licencia
[LICENCIA]…
Datos clave
- Categoría
- Programación y desarrollo · Documentación
- Tipo de resultado
- Código
- Nivel
- Principiante
- Pensado para
- ChatGPT, Claude y Gemini
- Verificado en
- Pendiente de verificación editorial
- Variables
- Nombre del proyecto, Descripción, Tecnologías y Público
- Idioma
- Español
- Precio
- Gratis, sin registro
- Actualizado
- 07/11/2026
Preguntas frecuentes
¿Qué significan los marcadores [VERIFICAR]?
Señalan comandos o ajustes que la IA no ha podido deducir de tu descripción. Sustitúyelos por los reales después de hacer tú mismo la instalación desde un clon limpio.
¿Sirve para un proyecto privado de empresa?
Sí. Indica tu equipo como público y sustituye la sección de licencia por vuestra política de uso interno.
¿Para qué sirve este prompt?
Crea un README claro y completo con instalación, uso, configuración y contribución a partir de la descripción de tu proyecto.
¿Con qué herramientas de IA funciona?
Está pensado para ChatGPT, Claude y Gemini. Todavía no lo hemos verificado en estas herramientas, por lo que los resultados pueden variar entre ellas.
¿Cómo personalizo el prompt?
Pulsa «Personalizar» y rellena las variables (Nombre del proyecto, Descripción, Tecnologías y Público). El texto se actualiza al instante y después puedes copiarlo con un clic. Los valores se guardan solo en tu navegador.
¿Necesito experiencia para usarlo?
No. Es un prompt de nivel principiante: basta con rellenar los datos y pegarlo en tu herramienta de IA.
¿Este prompt es gratis?
Sí. Todos los prompts de HomeCasa Prompts son gratuitos, sin registro ni suscripción. Puedes usarlos también en proyectos profesionales.
¿Puedo fiarme del resultado de la IA?
Úsalo como un borrador de calidad: revisa siempre datos, cifras y afirmaciones importantes antes de publicarlos o tomar decisiones.