README に開発のセットアップ方法を書こう（書いてくれ） - Qiita

READMEに何を書くべきか問題 リポジトリの顔とも言うべきREADMEに何を書くべきかは多くの方が議論されていると思いますが、ここではリポジトリのソースコードを利用して開発を始める時の手順（セットアップ）の記述に関して、自身の体験など踏まえて意見を整理しておきます。 READMEは誰が見るの？ リポジトリの作者や以前からのコミッターはそのリポジトリの内容に精通しているので、正直READMEなんて見なくても問題ないです。問題なのは初めてリポジトリを見に来た人たちです。ネットの大海原の中から奇跡的にこのリポジトリに辿り着いた通行人たち。リポジトリの目的や内容・特徴を簡潔に説明し、彼らに少しでも興味を持ってもらうための手段がREADMEと言えます。ですから、 READMEはリポジトリ初見の目線が大事です。 製作者のメモ書きみたいな暗号文を記載されても困ります。もっとも 数週間もすれば過去の自分