GitHubのREADME.mdに書くべき項目-GitHubの使い方

GitHubのREADME.mdに書くべき項目

考えるべき事項

• 使うユーザ側の立場で記載する
• 探し安くする
• すばらしい例をストックしておく
• 同じ方向性のプロジェクトを参考にする

README.md

• 何のためのプロジェクト（プログラム）なのか
• 構成図を載せておく
• 1ページですぐわかる、イメージしやすいようにしておく
• どのような言語で作成されているのか
• どのような利用しているフレームワーク
• どのような基盤で動作を想定しているのか
• 利用手順