Softonic

READMEジェネレーター

ステップ 1 / 4 README.md
次へ

空のリポジトリは第一印象がよくありません。プロジェクト名、1 行のキャッチコピー、機能の一覧、インストールコマンド、クイックスタートのスニペット、作者、ライセンスを入力すると、このジェネレーターが正しい見出し階層とフェンス付きコードブロックを備えたきれいな Markdown の README、つまり GitHub があなたのプロジェクトページに表示するセクションを生成します。コピーして、リポジトリのルートに README.md として保存し、プッシュしてください。セクションの見出しは英語で書かれます。これはオープンソースの README でほぼ共通の慣習です。一方、あなた自身が入力したテキストは、どの言語であっても入力したとおりに表示されます。

READMEの作り方

  1. 1

    基本情報を追加する

    プロジェクト名、任意のリポジトリ URL、1 行のキャッチコピー。名前は `#` の見出しになり、キャッチコピーはその下の引用になります。

  2. 2

    機能とクイックスタートを列挙する

    1 行に 1 つの機能（それぞれが箇条書きになります）と、フェンス付きコードブロックに収められる短いクイックスタートのスニペット。

  3. 3

    インストール、ライセンス、作者

    インストールコマンドは「Installation」の下の `bash` コードブロックに入ります。ライセンス（MIT、Apache-2.0…）と任意の作者行を追加します。

  4. 4

    Markdownをコピーする

    「コピー」をクリックし、出力をリポジトリのルートに `README.md` として貼り付けます。プッシュすると、レンダリングされた版がプロジェクトページに表示されます。

優れたREADMEに含まれるもの

GitHub 公式のスタイルガイドと、広く使われている standard-readme 仕様は、並び順について一致しています。ざっと読める部分を上部に置きましょう。あなたのリポジトリを訪れた人は、20 秒で読み続けるかどうかを判断します。

セクション 位置 目的
タイトル + キャッチコピー 1〜2 行目 # Project に続けて、何をするものかを 1 文で
バッジ 3〜5 行目 CI ステータス、npm バージョン、ライセンス、カバレッジ
インストール 折り返しより上 誰でもコピーできる 1 つのコマンド
使い方 折り返しより上 出力を生む最小限のスニペット
API / オプション 中間 フラグ、設定キー、エンドポイントの表
コントリビューション 終わり近く CONTRIBUTING.md、行動規範、PR の作法へのリンク
ライセンス 最後 SPDX 識別子と LICENSE へのリンク

本当に役立つバッジ

Shields.io の URL は予測しやすいパターンに従います：https://img.shields.io/badge/<label>-<message>-<color>.svg。役立つライブバッジは、ビルド状況、パッケージのバージョン、ダウンロード数を示すもので、見栄えだけの指標ではありません。ふつうは 4 つのバッジで十分で、それ以上はノイズです。

READMEでよくある間違い

  • 「インストール」の 1 行目にインストールコマンドがない。 読者は npm install や pip install を目で探します。文章の後ろに隠すと、去っていきます。
  • 3 MB のスクリーンショット。 幅 800px にリサイズして圧縮しましょう。GitHub はどのみち配信しますが、モバイルの読者は通信量を負担します。
  • 古いバッジ。 赤い CI バッジは、プロジェクトが壊れていると訪問者に伝えます。CI を直すか、バッジを外しましょう。
  • ライセンスがない。 ライセンスがないと、あなたのコードは既定で「無断転載禁止（all rights reserved）」となり、企業は使えません。

よくある質問

はい。フェンス付きコードブロック、箇条書き、ATX スタイルの見出し（# プレフィックス）は、いずれも変更なしで GitHub、GitLab、Bitbucket に表示されます。インストールコマンドは bash ブロックとしてタグ付けされ、クイックスタートのブロックはタグを付けずに残すので、言語はご自身で指定できます。

ほとんどのエコシステムでは README.md です。ドキュメントが Read the Docs にあり、Sphinx にそのファイルをランディングページとして再利用させたい Python パッケージを公開する場合のみ .rst を使ってください。

リポジトリ URL を指定すると、ジェネレーターは静的なライセンスバッジを 1 つ追加します（https://img.shields.io/badge/license-<type>-blue.svg）。ライブバッジ（ビルド状況、バージョン、ダウンロード数）が必要な場合は、shields.io の URL パターンをコピーして、出力にご自身で貼り付けてください。

いいえ。README はフォームの値から組み立てられ、何も保存されません。タブを閉じるとデータは消えます。

関連ツール

ASCII表リファレンス

0から127までの完全なASCII表です。NUL、LF、DELなどの制御コードを含め、各文字の10進数、16進数、8進数、2進数、HTML数値文字参照を表示します。

HTML文字参照

HTMLエンティティの検索可能なリスト、その名称コードおよび数値コード、および特殊文字や記号のワンクリックコピー機能を提供します。

キーボードショートカット一覧

macOS、Windows、Linux向けに、VS Code、Chrome、GNU Readlineを使うBashの公式資料に基づく既定ショートカットを検索できます。

JavaScript圧縮ツール

変数名のリネーム、空白の削除、デッドコードの除去、定数畳み込みでJavaScriptを圧縮し、より小さなバンドルを作成します。

EditorConfig ジェネレーター

インデント、改行コード、文字コードのルールから .editorconfig を作成し、リポジトリで使っている言語ごとに正しいセクションを追加します。Python、Go、YAML、Makefile などに対応。

メールアドレス検証ツール

メールアドレスを検証します。RFC 5322構文チェック、MXレコードのライブ確認に加え、ローカル部、ドメイン、長さの詳細を表示します。メールは送信されません。

このツールは他の言語でも利用できます