Read Me Launcher
Kernversprechen: eine README, die zum Repository passt.
Zuerst inspizieren. Niemals Stack-Fakten erfinden. Den minimalen ehrlichen Nachweis für die Zielgruppe wählen. Vor dem Abschluss auf Render-Brüche und geheimnisaussehende Zeichenketten linten.
Schritt 0: Klassifizieren
- Führen Sie
scripts/inspect-repo.shaus. - Bestimmen Sie INTERFACE × ZIELGRUPPE × PRIMÄRER_NACHWEIS (references/taxonomy.md).
- Ordnen Sie ggf. einer Modus-Kurzform zu (references/audience.md).
Harte Regeln (Fehler)
- Behauptungen über Installation/Ausführung/Tests stimmen mit Inspektionsausgabe überein (✓ verifiziert vs ? unbekannt)
- Keine erfundenen Features, Skripte oder Laufzeitumgebungen
- Keine Code-Blöcke innerhalb von
<div>/<section>/<center> - Lokale Bilder, auf die in der README verwiesen wird, existieren
-
scripts/check-readme.sh README.mdbeendet mit 0 (Secret- + Render-Prüfungen) - Datenschutzregeln in references/privacy.md
Starke Voreinstellungen (keine universellen Anforderungen)
- Bibliotheken beginnen mit funktionierendem Code, nicht mit Marketing-Wänden
- Interne Repos optimieren auf Runbooks, nicht auf Inszenierung
- Öffentliche GUIs benötigen meist einen echten Screenshot
- Banner/Vorschau/Showcase nur hinzufügen, wenn jedes Asset etwas beweist
- PNG bevorzugen, wenn Raster-Helden eingebettet werden (references/visuals.md)
Stilpräferenzen (Warnungen / Vorlieben)
- Gedankenstriche sind eine Vorliebe (
PREF); verwenden Sie--strict-stylenur, wenn der Benutzer harte Fehler wünscht - Standardmäßig maximal ~3 Badges oberhalb der Falz
- Emoji-Spam und Badge-Wände vermeiden
Arbeitsablauf
- Inspizieren -
scripts/inspect-repo.sh - Klassifizieren - Taxonomie + Zielgruppe
- Nachweis wählen - minimal notwendige Beweise
- README entwerfen - references/design.md, references/section-map.md
- Assets nur bei Bedarf generieren - references/generation.md
- Linten -
scripts/check-readme.sh README.md - Konsumentenprüfung - Würde ein Fremder aus dem ersten Bildschirm installieren?
Markierungen für Behauptungen (empfohlen in Entwürfen / Reviews)
| Markierung | Bedeutung |
|---|---|
| ✓ verifiziert | Bestätigt durch Inspektion/Manifeste |
| ~ abgeleitet | Vernünftig, aber nicht explizit im Repo |
| ? unbekannt | Nicht als Tatsache darstellen |
| ✗ nicht unterstützt | Entfernen oder umschreiben |
Ausgaberegeln
- README (und Assets nur, wenn begründet) schreiben
- Korrektur einer bestehenden guten README bevorzugen gegenüber zerstörerischen Neuschreibungen
- Kein „Generiert von KI“
- Nicht behaupten, „secret-sicher“ zu sein, über das hinaus, was
check-readme.shprüft; verbleibendes Risiko benennen
Gebündelte Ressourcen
| Pfad | Wann |
|---|---|
| scripts/inspect-repo.sh | Immer zuerst |
| scripts/check-readme.sh | Immer vor Abschluss |
| references/taxonomy.md | Klassifikation |
| references/audience.md | Nachweismodus |
| references/visuals.md | Bildformate |
| references/generation.md | Asset-Anweisungen / -Verbote |
| references/design.md | Struktur |
| references/privacy.md | Öffentlich/Privat + Deny-Liste |
| references/section-map.md | Abschnitte nach Typ |
| tests/run-tests.sh | Lokale Verifikation |