README.md
Githubでは当たり前に設定されているので、しっかり参考にする 書き方を勉強したいのでいろいろ参考にする
参考にしたいREADME.md
良いところ
Config, installの手順が細かく記載されている
詳細部分を<details>で狭めている
imageがつくUIをscreenshotで貼り付けている
良いところ
利用imageがgif animationで表示されている
良いところ
「Contents」として最初に目次がある
code:.md
良いところ
ほぼ箇条書きで構造化されているので読みやすい
良いところ
Getting Startedが最初にある
良いところ
screenshotモタ酔いしてかなり詳細に「利用image」が記載されている。
必要なlibrary versionがbatch形式で最初に表示されている
code:.md
良いところ
「What is」「Why use」が最初にあってこのrepositoryの必要性/全体感を理解しやすい
良いところ
「Usage (command option)」が一覧化されていて、利用imageが湧きやすい