thatdudealso/read-me-launcher

Read Me Launcher

Promesse centrale : un README qui correspond au dépôt.

Inspectez d'abord. N'inventez jamais de fait sur la pile technique. Choisissez la preuve minimale honnête pour le public. Vérifiez les erreurs de rendu et les chaînes ressemblant à des secrets avant de terminer.

Étape 0 : classifier

1. Exécutez scripts/inspect-repo.sh.
2. Résolvez INTERFACE × AUDIENCE × PRIMARY_PROOF (references/taxonomy.md).
3. Mappez vers un mode abrégé si utile (references/audience.md).

Règles strictes (erreurs)

• Les affirmations sur l'installation/le lancement/les tests correspondent à la sortie de l'inspection (✓ vérifié vs ? inconnu)
• Pas de fonctionnalités, scripts ou environnements d'exécution inventés
• Pas de blocs de code à l'intérieur de <div> / <section> / <center>
• Les images locales référencées par le README existent
• scripts/check-readme.sh README.md se termine avec le code 0 (vérifications de secrets et de rendu)
• Règles de confidentialité dans references/privacy.md

Valeurs par défaut fortes (non impératives)

• Les bibliothèques commencent par du code fonctionnel, pas des affiches marketing
• Les dépôts internes optimisent pour les runbooks, pas pour le théâtre de lancement
• Les interfaces graphiques publiques nécessitent généralement une vraie capture d'écran
• Ajoutez bannière/aperçu/démo seulement lorsque chaque élément apporte une preuve
• Préférez le PNG pour intégrer des images bitmap héroïques (references/visuals.md)

Préférences stylistiques (avertissements / préférences)

• Les tirets cadratins sont une préférence (PREF) ; utilisez --strict-style seulement si l'utilisateur souhaite des échecs stricts
• Maximum ~3 badges au-dessus de la ligne de flottaison par défaut
• Évitez les émojis superflus et les murs de badges

Workflow

1. Inspecter - scripts/inspect-repo.sh
2. Classifier - taxonomie + public
3. Choisir la preuve - minimum de preuves nécessaires
4. Rédiger le README - references/design.md, references/section-map.md
5. Générer les éléments uniquement si nécessaire - references/generation.md
6. Vérifier - scripts/check-readme.sh README.md
7. Passage grand public - un inconnu installerait-il depuis le premier écran ?

Marqueurs de revendication (recommandés dans les brouillons / relectures)

Marqueur	Signification
✓ vérifié	Confirmé par l'inspection / les manifests
~ inféré	Raisonnable mais pas explicite dans le dépôt
? inconnu	Ne pas présenter comme un fait
✗ non supporté	Supprimer ou reformuler

Règles de sortie

• Rédigez le README (et les éléments seulement lorsqu'ils sont justifiés)
• Préférez corriger un bon README existant plutôt que de le réécrire complètement
• Pas de « Généré par IA »
• Ne prétendez pas être « à l'abri des secrets » au-delà de ce que check-readme.sh analyse ; signalez les risques résiduels

Ressources incluses

Chemin	Quand
scripts/inspect-repo.sh	Toujours en premier
scripts/check-readme.sh	Toujours avant de terminer
references/taxonomy.md	Classification
references/audience.md	Mode de preuve
references/visuals.md	Formats d'images
references/generation.md	Invites / interdictions d'éléments
references/design.md	Structure
references/privacy.md	Public/privé + liste d'exclusion
references/section-map.md	Sections par type
tests/run-tests.sh	Vérification locale