前提
個人開発の小さなプロジェクトでも見てもらう時のためにREADMEはしっかり書いておくべきと聞いたので、調べた結果を残したものです
前提を踏まえた上でのREADMEの目的
第三者から見て、どのようなプロジェクトなのかと、どのようなスキルを持っているかが伝えることが大切だと思います
READMEに書くべき項目
- プロジェクトの概要
- どんな技術が使われているのか
詳しいプロジェクトの説明や、躓いた点などは別で書くので、READMEにはこれらが分かりやすく書いてあるべきだと思っています
(他に書くべきことがありましたら教えてください🙇)
最後に
あくまで今回の話は自分の簡単なプロジェクトかつ、個人開発に限った話です
改行を入れるなどの書き方の面には触れていない点も注意してください
