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

分かりやすくてカッコイイ名前をつける（今回は"hoge"という名前をつける） "hoge"が何かを簡潔に紹介する

DEMO

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

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

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

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

pip install huga_package

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

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

注意点などがあれば書く

作成情報を列挙する

ライセンスを明示する

"hoge" is under MIT license.

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

Name		Name	Last commit message	Last commit date
Latest commit History 72 Commits
.github/workflows		.github/workflows
.vscode		.vscode
api		api
cmd/go-weed		cmd/go-weed
db		db
internal		internal
router		router
.gitignore		.gitignore
Dockerfile		Dockerfile
config.docker_local.json		config.docker_local.json
config.local.json		config.local.json
config.production.json		config.production.json
docker-compose.yml		docker-compose.yml
go.mod		go.mod
go.sum		go.sum
localhost.session.sql		localhost.session.sql
readme.md		readme.md