README completo
- Dominant language
- Shell
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Qué es esta tarea
Escribir el README completo del producto: instalación, configuración, uso y troubleshooting. Incluye la lista blanca de comandos documentada públicamente como transparencia operativa.
## Qué se debe hacer
- Escribir un README con las secciones:
- **Qué es Doctor J/K**: descripción en una frase + los 3 modos de operación
- **Instalación**: prerrequisitos, ejecución de `install.sh`, verificación
- **Configuración**: `config.toml` con todos los parámetros y sus valores por defecto
- **Uso**: cómo consultar informes, cómo activar Modo 2 y Modo 3, flags disponibles
- **Lista blanca de comandos**: documentación pública de qué comandos puede ejecutar el Modo 3
- **Troubleshooting**: problemas comunes y cómo resolverlos
- El README debe ser suficiente para que alguien externo instale y use el producto
## Por qué importa
El criterio de avance de la Fase 10 dice: "Alguien externo puede leer el README, instalar en <15 min y entender qué hace el agente sin ver el código." Para un producto cerrado, el README es la única interfaz entre el producto y el usuario — si no está bien escrito, el producto no se adopta.
## Criterio de avance
Una persona que no ha visto el proyecto antes puede leer el README, instalar Doctor J/K en un VPS limpio en <15 minutos, y entender los 3 modos de operación y cómo consultar informes.
Contributor guide
Assessment
This issue has not been assessed yet.