Read Me Launcher
Promessa central: um README que corresponde ao repositório.
Inspecione primeiro. Nunca invente fatos sobre a stack. Escolha a evidência honesta mínima para o público. Execute o lint para verificar quebras de renderização e strings que pareçam segredos antes de finalizar.
Etapa 0: classificar
- Execute
scripts/inspect-repo.sh. - Resolva INTERFACE × PÚBLICO × PROVA_PRIMÁRIA (references/taxonomy.md).
- Mapeie para uma abreviatura de modo, se útil (references/audience.md).
Regras rígidas (erros)
- Afirmações sobre instalação/execução/teste correspondem à saída da inspeção (✓ verificado vs ? desconhecido)
- Nenhum recurso, script ou runtime inventado
- Nenhum bloco de código dentro de
<div>/<section>/<center> - Imagens locais referenciadas pelo README existem
-
scripts/check-readme.sh README.mdtermina com código 0 (verificações de segredos e renderização) - Regras de privacidade em references/privacy.md
Padrões fortes (não mandatórios universais)
- Bibliotecas começam com código funcional, não com murais de marketing
- Repositórios internos otimizam para runbooks, não para teatro de lançamento
- GUIs públicas geralmente precisam de uma captura de tela real
- Adicione banner/prévia/showcase apenas quando cada ativo prova algo
- Prefira PNG ao incorporar imagens raster heróicas (references/visuals.md)
Preferências de estilo (avisos/prefs)
- Travessões longos (—) são uma preferência (
PREF); use--strict-styleapenas se o usuário quiser falhas rígidas - Máximo de ~3 badges acima da dobra por padrão
- Evite spam de emojis e paredes de badges
Fluxo de trabalho
- Inspecionar -
scripts/inspect-repo.sh - Classificar - taxonomia + público
- Escolher prova - evidência mínima necessária
- Elaborar README - references/design.md, references/section-map.md
- Gerar ativos apenas se necessário - references/generation.md
- Lint -
scripts/check-readme.sh README.md - Passagem do consumidor - um estranho instalaria a partir da primeira tela?
Marcadores de afirmação (recomendados em rascunhos/revisões)
| Marcador | Significado |
|---|---|
| ✓ verificado | Confirmado a partir da inspeção/manifestos |
| ~ inferido | Razoável, mas não explícito no repositório |
| ? desconhecido | Não apresente como fato |
| ✗ não suportado | Remova ou reescreva |
Regras de saída
- Escreva o README (e ativos apenas quando justificado)
- Prefira corrigir um README existente e bom a reescritas destrutivas
- Sem "Gerado por IA"
- Não afirme excessivamente "seguro contra segredos" além do que
check-readme.shverifica; aponte riscos residuais
Recursos agrupados
| Caminho | Quando |
|---|---|
| scripts/inspect-repo.sh | Sempre primeiro |
| scripts/check-readme.sh | Sempre antes de finalizar |
| references/taxonomy.md | Classificação |
| references/audience.md | Modo de evidência |
| references/visuals.md | Formatos de imagem |
| references/generation.md | Prompts/proibições de ativos |
| references/design.md | Estrutura |
| references/privacy.md | Público/privado + lista de negação |
| references/section-map.md | Seções por tipo |
| tests/run-tests.sh | Verificação local |