generated at
README.md

Githubでは当たり前に設定されているので、しっかり参考にする

書き方を勉強したいのでいろいろ参考にする
https://deeeet.com/writing/2014/07/31/readme/
https://qiita.com/koeri3/items/f85a617dcb6efebb2cab
GitHub - matiassingers/awesome-readme: A curated list of awesome READMEs


参考にしたいREADME.md
size-limit/README.md at main · ai/size-limit · GitHub
良いところ
Config, installの手順が細かく記載されている
詳細部分を <details> で狭めている
imageがつくUIをscreenshotで貼り付けている
GitHub - ajeetdsouza/zoxide: A smarter cd command. Supports all major shells.
良いところ
利用imageがgif animationで表示されている
GitHub - alichtman/shallow-backup: Git-integrated backup tool for macOS and Linux devs.
良いところ
「Contents」として最初に目次がある
.md
* [Why?](#why) * [Installation](#installation) * [Usage](#usage) * [Git Integration](#git-integration) * [What can I back up?](#what-can-i-back-up) * [Configuration](#configuration) * [Output Structure](#output-structure) * [Reinstalling Dotfiles](#reinstalling-dotfiles) * [Want to contribute?](#want-to-contribute)
GitHub - alichtman/stronghold: Easily configure macOS security settings from the terminal.
良いところ
ほぼ箇条書きで構造化されているので読みやすい
GitHub - amplication/amplication: Amplication is an open‑source development tool. It helps you develop quality Node.js applications without spending time on repetitive coding tasks.
良いところ
Getting Startedが最初にある
GitHub - anfederico/clairvoyant: Software designed to identify and monitor social/historical cues for short term stock movement
良いところ
screenshotモタ酔いしてかなり詳細に「利用image」が記載されている。
必要なlibrary versionがbatch形式で最初に表示されている
.md
![Python](https://img.shields.io/badge/python-v3.6+-blue.svg) [![Build Status](https://travis-ci.org/anfederico/clairvoyant.svg?branch=master)](https://travis-ci.org/anfederico/clairvoyant) ![Dependencies](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg) [![GitHub Issues](https://img.shields.io/github/issues/anfederico/clairvoyant.svg)](https://github.com/anfederico/clairvoyant/issues) ![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
GitHub - zenml-io/zenml: ZenML 🙏: MLOps framework to create reproducible pipelines. https://zenml.io.
良いところ
「What is」「Why use」が最初にあってこのrepositoryの必要性/全体感を理解しやすい
GitHub - xnbox/DeepfakeHTTP: DeepfakeHTTP is a web server that uses HTTP dumps as a source for responses.
良いところ
「Usage (command option)」が一覧化されていて、利用imageが湧きやすい