Read Me Launcher
核となる約束: リポジトリに適合したREADME
まず検査すること。スタックに関する事実を捏造しないこと。 オーディエンスに応じた最小限の正直な証拠を選択すること。 終了前に、レンダリングの破損や秘密情報らしき文字列をリントすること。
ステップ0: 分類
scripts/inspect-repo.shを実行する。- インターフェース × オーディエンス × プライマリプルーフ を解決する (references/taxonomy.md)。
- 必要に応じてモードの省略形にマッピングする (references/audience.md)。
ハードルール（エラー）
- インストール/実行/テストに関する主張が検査出力と一致している（✓ 確認済み vs ? 不明）
- 発明された機能、スクリプト、ランタイムがないこと
-
<div>/<section>/<center>内にコードフェンスがないこと - READMEから参照されているローカル画像が存在すること
-
scripts/check-readme.sh README.mdが終了コード0で終了すること（秘密情報＋レンダリングチェック） - references/privacy.md のプライバシールールに従っていること
強いデフォルト（普遍的な必須事項ではない）
- ライブラリはマーケティングの壁画ではなく、動作するコードで始めること
- 内部リポジトリは発表の演出ではなく、運用手順書に最適化すること
- 公開GUIは通常、1つの実際のスクリーンショットがあれば十分である
- 各アセットが何かを証明する場合にのみ、バナー/プレビュー/ショーケースを追加すること
- ラスターヒーローを埋め込む際はPNGを推奨する (references/visuals.md)
スタイルの推奨（警告 / プリファレンス）
- ダッシュ（—）は推奨スタイル（
PREF）です。ユーザーがハードエラーを希望する場合のみ--strict-styleを使用すること - デフォルトでは、折り畳み上部に最大約3つのバッジ
- 絵文字の多用やバッジの壁を避けること
ワークフロー
- 検査 -
scripts/inspect-repo.sh - 分類 - 分類法 + オーディエンス
- 証拠を選択 - 必要最小限の証拠
- READMEをドラフト - references/design.md, references/section-map.md
- 必要な場合のみアセットを生成 - references/generation.md
- リント -
scripts/check-readme.sh README.md - 利用者視点での確認 - 初めて見た人は最初の画面からインストールできるか？
主張マーカー（ドラフト/レビューで推奨）
| マーカー | 意味 |
|---|---|
| ✓ 確認済み | 検査/マニフェストから確認済み |
| ~ 推測 | リポジトリから合理的に推測できるが明示的ではない |
| ? 不明 | 事実として提示しないこと |
| ✗ 非対応 | 削除または書き直すこと |
出力ルール
- README（および正当な場合のみアセット）を作成すること
- 既存の良いREADMEを破壊的に書き換えるのではなく、修正することを優先すること
- 「AIによって生成されました」を入れないこと
check-readme.shがスキャンする範囲以上に「秘密情報セーフ」と主張しないこと。残留リスクを明記すること
バンドルされているリソース
| パス | 使用タイミング |
|---|---|
| scripts/inspect-repo.sh | 常に最初 |
| scripts/check-readme.sh | 常に終了前 |
| references/taxonomy.md | 分類 |
| references/audience.md | 証拠モード |
| references/visuals.md | 画像フォーマット |
| references/generation.md | アセットプロンプト/禁止事項 |
| references/design.md | 構造 |
| references/privacy.md | 公開/非公開 + 拒否リスト |
| references/section-map.md | タイプ別セクション |
| tests/run-tests.sh | ローカル検証 |