README上級

なぜ大事?

GitHubは、置き場を開くとこのファイルを自動で表示します。ここに何も書いていないと、他の人にはただのファイルの山にしか見えません。使ってもらえるかどうかが、ここで決まります。

やさしい解説

名前は「まず読んで」という意味です。大文字で書くのは、ファイルが並んだときに目立たせるための昔からの習わしです。

書くことは4つで足ります。

1. これは何か（1行で）
2. 何ができるか
3. どう使い始めるか
4. 誰が作って、どう使ってよいか（ライセンス）

いちばん大事なのは1行目です。読む人は、最初の1行で「自分に関係あるか」を決めます。

自分だけの置き場でも書く価値があります。半年後の自分は、作ったときのことをきれいに忘れているからです。

例文

• 「GitHubに置いたけど誰も使ってくれない」「READMEは書いた? 何ができるか1行目に書くといいよ」
• 「自分用でも要る?」「半年後の自分は他人だからね。READMEは要るよ」