短いフォームに入力すると、インストール手順、使い方、設定、ライセンス付きの整ったREADME.md、またはKeep a Changelog形式のCHANGELOG.mdが得られます。入力に合わせて結果が表示されます。すべてブラウザ上で書かれ、入力した内容がアップロードされることはありません。無料です。
READMEの作り方、手順ごとに
- 上部で、README.mdを選びます。
- 「プロジェクトについて」で、「プロジェクト名」「1行の要約」「説明」と、1行に1つの「機能」と「要件」を入力します。
- 「インストールと使い方」で、npm、pip、Cargoなどの「パッケージマネージャー」を選び、「リポジトリのURL」を追加して、「使い方」を書きます。コードが正しく整形されるよう、「使い方の言語」を選びます。
- 該当する場合は、「設定」と「開発」のコマンドを追加します。
- 「ライセンス」と「著作権者」を選び、必要に応じて、「目次」「ライセンスバッジ」「コントリビューション」のセクションをオンにします。
- 「Markdownをコピー」または「README.mdをダウンロード」を押します。
よいREADMEとは
プロジェクトが何をするかを1行で述べ、そのあと、インストール方法と、動作する最小の例を示します。読み手は、プロジェクトが合うかどうかを数秒で判断するため、機能と要件が次に来て、設定、開発コマンド、貢献の方法、ライセンスが続きます。空のままのセクションは除かれます。
読める変更履歴
変更履歴は、Keep a Changelogに従います：最新のリリースが最初で、それぞれ日付付きで、変更が、追加、変更、非推奨、削除、修正、セキュリティにまとめられます。まだ公開されていない変更用に、上部に「Unreleased」のセクションを残します。リポジトリのアドレスがあれば、各バージョンは、その前のものとの比較にリンクします。古いリリースは、手動で追加するか、コミットメッセージから項目を作成できます。
ヒント
- 動作するインストールコマンドと、短い使用例を、上のほうに置いてください。
- 他の人があなたのコードをどう使えるかわかるよう、ライセンスを明確に記載してください。
- 説明は、どう作ったかではなく、プロジェクトが読み手に何をするかについて書いてください。
- 最後だけでなく、リリースごとに変更履歴を更新してください。
秘密情報とビルドファイルをリポジトリに入れないようにするには、.gitignore作成とenv例ジェネレーターを使ってください。
よくある質問
コミット履歴から始められますか？
はい。「コミットメッセージから」の下にgit log --onelineの出力を貼り付けます。feat:、fix:、perf:などの形式で書かれたコミットは、適切なグループに分類され、感嘆符で示された破壊的変更にはラベルが付きます。あとから文言を編集してください。コミットメッセージは開発者向け、変更履歴はユーザー向けに書かれるものです。
ライセンスの全文は追加されますか？
ライセンスのセクションが追加され、ライセンス名とLICENSEファイルへの参照が入ります。ライセンスの全文はそのファイルに入れてください。全文はライセンスの公式ページにあります。
ファイルはどこに置きますか？
「ダウンロード」を押すと、README.mdまたはCHANGELOG.mdが端末に保存されます。リポジトリの最上位に置くと、コードホスティングサービスがプロジェクトのページに表示します。
どのライセンスを選べますか？
MIT、Apache 2.0、GPL 3.0、BSD 3-Clause、ISC、MPL 2.0、Unlicense、All rights reserved から選べ、セクションなしも選べます。