Cómo crear un README con una instalación reproducible.
Un README debe permitir reproducir la instalación a partir de requisitos verificados. Distingue las instrucciones comprobadas de comandos propuestos o configuración no disponible.
Adapta el flujo de trabajo a tu tarea.
Usa los scripts, requisitos previos y configuración reales del repositorio para explicar instalación y primer uso. Distingue comandos verificados de pasos propuestos, excluye secretos de los ejemplos y ofrece una ruta clara para probar.
- Qué aportas
- Comportamiento verificado del proyecto y requisitos de instalación.
- Qué obtienes
- Documentación con pasos ejecutables pendientes de verificación.
Mira la entrada y el resultado.
Entrada y salida ilustrativas · ejemplo didáctico, no una ejecución de WebAct en directo
Ejemplo campo
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
Ejemplo completo
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
Carga esta entrada en el prompt y cópialo en WebAct para probar la tarea. Tu resultado puede diferir del ejemplo.
Decisiones y solución de problemas.
¿Debe un README inventar un comando de instalación que suene habitual?
Comprueba el proyecto primero. Un comando conocido puede ser incorrecto para el gestor de paquetes, archivo de bloqueo o proceso de compilación utilizado.
¿Por qué falla la instalación aunque se siga el README?
Compara versiones del entorno, configuración necesaria y scripts reales. Reproduce el paso ausente en lugar de añadir un párrafo genérico de solución de problemas.
Pruébalo con tu propia fuente.
Sustituye el ejemplo por tu material en el prompt. Conserva los requisitos que necesites y copia la tarea en WebAct.
Personalizar y copiar la tarea ↑