📘README ジェネレーター
プロジェクト名、機能、技術スタック、セットアップの手順を入れるだけで、GitHub 向けの README.md を作ります。個人開発のリポジトリを公開するときのひな形にどうぞ。
読まれる README のコツ
- 1行目の説明で「誰の何を解決するか」を書く
- スクリーンショットか GIF を1枚入れる
- セットアップはコピーしてそのまま動くコマンドにする
- 公開している URL があれば一番上に置く
Markdown の見え方は Markdown → HTML 変換 で確認できます。
よくある質問
- Q. READMEには何を書けばいい？
- 何のプロジェクトか、主な機能、使っている技術、セットアップと起動の方法、ライセンスの5つがあれば十分です。
- Q. README.mdのmdとは？
- Markdown（マークダウン）形式のファイルという意味です。GitHub ではリポジトリのトップに自動で表示されます。
- Q. スクリーンショットを入れるには？
- 画像をリポジトリに置き、 のように書きます。GitHub の Issue に画像を貼って、その URL を使う方法もあります。
- Q. ライセンスは何を選べばいい？
- 自由に使ってほしいなら MIT が一般的です。ソースを見せたいだけで使ってほしくない場合は、ライセンスを付けない（All rights reserved）という選択もあります。