はじめに GitHubでレポジトリを作成すると最初に作成されるREADME.md。 デフォルトのまま放置していたりしませんか? README.mdはレポジトリの顔です。 ここを整えておくことで、レポジトリのクオリティをぐっと上げることができます。 しかし、README.mdに何を書いたらいいのか、わからないという人も多いと思います。 この記事ではおすすめの構成をまとめます。 README.mdの読者はだれか? まず、誰に向けてREADME.mdを書くのかというところから考えることから始めましょう。 README.mdの読者は大きく分けてユーザと開発者の2種類います。そのレポジトリを閲覧するひとはユーザが多いのか、開発者が多いのかを想定してどちらをメインで書くか決めると良いでしょう。 README.mdは英語で書くべき? 有名OSSはすべて英語でREADME.mdが書かれているため、当然英語
![イケてるレポジトリのREADME.mdには何を書くべきか - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/32306079b1f59bc68d71a3881637fcf0c39d7ff6/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZ0eHQ9JUUzJTgyJUE0JUUzJTgyJUIxJUUzJTgxJUE2JUUzJTgyJThCJUUzJTgzJUFDJUUzJTgzJTlEJUUzJTgyJUI4JUUzJTgzJTg4JUUzJTgzJUFBJUUzJTgxJUFFUkVBRE1FLm1kJUUzJTgxJUFCJUUzJTgxJUFGJUU0JUJEJTk1JUUzJTgyJTkyJUU2JTlCJUI4JUUzJTgxJThGJUUzJTgxJUI5JUUzJTgxJThEJUUzJTgxJThCJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmdHh0LWNsaXA9ZWxsaXBzaXMmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz04NzNmMmRlYTczMTkyZDRjOWQ5MmIwZDE4YzQ4NjgxZA%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwYXV0b3Rha2VyMTk4NCZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9OWU3MzMxOGFmMTUzNmNhYjNmNzMxNjRiZDliNTdiNGI%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3Df06b2819b17351e72a2be43d5d7b86d2)