README Generator

使い方

1. プロジェクト名と 1 行の概要を入力します。
2. インストールコマンドと、任意で使用例を入力します。どちらもコードフェンスで囲まれます。
3. ライセンスを選ぶか「なし」を選びます。バッジ行は自動で追加できます。
4. Markdown をコピーするか、README.md としてダウンロードします。

よくある用途

• 新しいリポジトリ — 「ドキュメントは後日」ではなく、最初の push 前にまともな README を用意。
• チーム出力の標準化 — 内部プロジェクトが常に同じセクション順で始まるように。
• OSS 公開前 — ライセンス行とバッジを一括で追加。
• 社内ツール — 小さなスクリプトにまともな顔を付け、エディタを開かずに済ませる。

よくある質問

Q: バッジはどこから来ますか？ A: バッジは Markdown に埋め込まれた shields.io の静的画像リンクです。ファイルをコミットすれば GitHub や多くの Git ホストで表示されます。ツール自体は読み込みません。

Q: Contributing や Tests などのセクションを追加できますか？ A: 生成物は普通の Markdown です。エディタに貼って拡張してください。共通セクションの順序が固定されるので、追記の土台が安定します。

Q: ライセンス「なし」を選ぶと何が出力されますか？ A: ライセンス未選択であり、デフォルトは全著作権留保である旨の説明が出力されます。ライセンス未設定の公開リポジトリの正確な状態です。