Name(リポジトリ/プロジェクト/OSSなどの名前)

分かりやすくてカッコイイ名前をつける(今回は"hoge"という名前をつける)

"hoge"が何かを簡潔に紹介する

DEMO

"hoge"の魅力が直感的に伝えわるデモ動画や図解を載せる

Features

"hoge"のセールスポイントや差別化などを説明する

Requirement

"hoge"を動かすのに必要なライブラリなどを列挙する

Installation

Requirementで列挙したライブラリなどのインストール方法を説明する

pip install huga_package

Usage

DEMOの実行方法など、"hoge"の基本的な使い方を説明する

git clone https://github.com/hoge/~ cd examples python demo.py

Note

注意点などがあれば書く

Author

作成情報を列挙する

License

ライセンスを明示する

"hoge" is under MIT license.

社内向けなら社外秘であることを明示してる

"hoge" is Confidential.