¿Qué hace write-project-readme?
Instala una habilidad de Codex basada en evidencia para READMEs completos de proyectos.
Esta habilidad de Codex te permite generar automáticamente un archivo README completo y profesional para tu proyecto. Analiza tu código existente, extrae información relevante y estructura la documentación en secciones estándar, incluyendo instalación, uso, ejemplos, configuración y más.
Instalación
dfx install montasim/write-project-readme
Uso
- Asegúrate de tener Codex instalado y configurado.
- Navega al directorio raíz de tu proyecto.
- Ejecuta el siguiente comando:
codex write-project-readme
Esto analizará tu proyecto y generará un archivo README.md en el directorio actual.
Personalización
Puedes personalizar el README generado editando el archivo de configuración de la habilidad, ubicado en ~/.codex/skills/montasim/write-project-readme/config.yaml. Allí puedes definir secciones adicionales, modificar el orden o excluir ciertos análisis.
Soporte
Para reportar problemas o sugerir mejoras, visita el repositorio oficial: montasim/write-project-readme
Licencia
MIT