thatdudealso/read-me-launcher

Read Me Launcher

Promesa central: un README que coincida con el repositorio.

Inspecciona primero. Nunca inventes datos sobre el stack. Elige la prueba honesta mínima para la audiencia. Aplica linting para detectar errores de renderizado y cadenas con apariencia de secretos antes de finalizar.

Paso 0: clasificar

1. Ejecuta scripts/inspect-repo.sh.
2. Determina INTERFAZ × AUDIENCIA × PRUEBA_PRINCIPAL (references/taxonomy.md).
3. Mapea a una abreviatura de modo si es útil (references/audience.md).

Reglas estrictas (errores)

• Las afirmaciones sobre instalación/ejecución/prueba coinciden con la salida de inspección (✓ verificado vs ? desconocido)
• No hay características, scripts o entornos de ejecución inventados
• No hay bloques de código dentro de <div> / <section> / <center>
• Las imágenes locales referenciadas por el README existen
• scripts/check-readme.sh README.md sale con código 0 (verificaciones de secretos y renderizado)
• Reglas de privacidad en references/privacy.md

Valores predeterminados sólidos (no mandatos universales)

• Las bibliotecas comienzan con código funcional, no con murales de marketing
• Los repositorios internos se optimizan para manuales operativos, no para teatro de lanzamiento
• Las GUIs públicas generalmente necesitan una captura de pantalla real
• Agrega banner/vista previa/muestra solo cuando cada activo demuestre algo
• Prefiere PNG al incrustar imágenes rasterizadas principales (references/visuals.md)

Preferencias de estilo (advertencias / preferencias)

• Los guiones largos son una preferencia (PREF); usa --strict-style solo si el usuario quiere fallos estrictos
• Máximo ~3 insignias sobre el pliegue por defecto
• Evita la saturación de emojis y muros de insignias

Flujo de trabajo

1. Inspeccionar - scripts/inspect-repo.sh
2. Clasificar - taxonomía + audiencia
3. Elegir prueba - evidencia mínima necesaria
4. Redactar README - references/design.md, references/section-map.md
5. Generar activos solo si es necesario - references/generation.md
6. Aplicar linting - scripts/check-readme.sh README.md
7. Pase de consumidor - ¿un extraño instalaría desde la primera pantalla?

Marcadores de afirmaciones (recomendados en borradores / revisiones)

Marcador	Significado
✓ verificado	Confirmado desde inspección/manifiestos
~ inferido	Razonable pero no explícito en el repositorio
? desconocido	No presentar como hecho
✗ no compatible	Eliminar o reescribir

Reglas de salida

• Escribe el README (y activos solo cuando esté justificado)
• Prefiere corregir un README existente y bueno sobre reescrituras destructivas
• Sin "Generado por IA"
• No afirmes en exceso "seguro contra secretos" más allá de lo que check-readme.sh escanea; señala el riesgo residual

Recursos incluidos

Ruta	Cuándo
scripts/inspect-repo.sh	Siempre primero
scripts/check-readme.sh	Siempre antes de finalizar
references/taxonomy.md	Clasificación
references/audience.md	Modo de evidencia
references/visuals.md	Formatos de imagen
references/generation.md	Prompts/prohibiciones de activos
references/design.md	Estructura
references/privacy.md	Público/privado + lista de denegación
references/section-map.md	Secciones por tipo
tests/run-tests.sh	Verificación local