分かりやすくてカッコイイ名前をつける（今回は"hoge"という名前をつける）
"hoge"が何かを簡潔に紹介する
"hoge"の魅力が直感的に伝えわるデモ動画や図解を載せる
"hoge"のセールスポイントや差別化などを説明する
"hoge"を動かすのに必要なライブラリなどを列挙する
- huga 3.5.2
- hogehuga 1.0.2
Requirementで列挙したライブラリなどのインストール方法を説明する
pip install huga_packageDEMOの実行方法など、"hoge"の基本的な使い方を説明する
git clone https://github.com/hoge/~
cd examples
python demo.py注意点などがあれば書く
作成情報を列挙する
- 作成者
- 所属
ライセンスを明示する
"hoge" is under MIT license.
社内向けなら社外秘であることを明示してる
"hoge" is Confidential.