良い README.md を書くためのテンプレート（翻訳） - Qiita
GitHub Gist でBillie Thompson さん が公開している 良い README.md を書くためのテンプレート | A template to make good README.md という Gist が良さそうだったので日本語に翻訳しました。 このマークダウン文書は、オープンソースプロジェクトの README.md をテンプレート化したもので、プロジェクトの概要説明から開発環境の立ち上げ、貢献方法への案内などを簡潔にまとめる方法が書かれています。オープンソースのライブラリを公開するときなどにコピーして使うと良さそうです。 翻訳は見出し・パラグラフ・リスト等ごとに原文と日本語文を併記する形にしました。誤字や翻訳の間違いなどがあると思いますので、編集リクエスト歓迎です。 Project Title / プロジェクトのタイトル One Paragraph of projec
わかりやすいREADME.mdを書く
GitHubなどに自分のツールやライブラリを公開するとき，README.mdは重要な役割を担っている．レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている，と言っても過言ではない．実際自分が使う側になったときも，まずREADME.mdを読んで判断していると思う． 成功しているプロジェクトを参考にしつつ，自分が実践していることをまとめておく．ここに書いていることはあくまで（自分の中で）最低限的なものである．プロジェクトが成長していくにつれてREADMEはあるべき姿に成長していくべきだと思う． READMEの役割 README.mdには大きく2つの役割がある． プロジェクト，ツールの使い方，インストール方法 プロジェクト，ツールの宣伝 元々READMEは前者の役割しかなかったが，GitHubの仕組み上，後者の役割も徐々に重要になっている． さらに
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
