エンジニア英語

READMEの英語の書き方:見出しと例文

簡単な答え

READMEの英語の書き方は、プロジェクト名と1行の説明、特徴、インストール、使い方、設定、貢献の方法、ライセンスの順に見出しを立て、短い命令形や現在形の文で埋めるのが基本です。GitHubもREADMEを、何ができ、なぜ役立ち、どう使うかを伝える場所としています。Devlingoで学べます。

更新日 3 分で読めますGambit Studio

インストールなしで使う →ブラウザで無料、登録不要

GitHubのドキュメントでは、READMEはプロジェクトがなぜ役立つのか、何ができるのか、どう使えるのかを伝えるファイルで、ライセンスや投稿ガイドラインとともにプロジェクトへの期待を伝えるものとされています(GitHub Docs)。

英語のREADMEの見出しテンプレート

見出し書くこと例文
# Project name名前と1行の説明A tiny CLI to rename photos by date.
## Features主な機能を箇条書き- Renames files using EXIF dates
## Requirements必要な環境Node.js 20 or later
## Installationインストール手順Install the package with npm:
## Usage使い方とコマンド例Run the command in your photo folder:
## Configuration設定項目You can change the date format in config.json.
## Contributing貢献の方法Pull requests are welcome. For major changes, please open an issue first.
## LicenseライセンスThis project is licensed under the MIT License.

READMEでよく使う表現

英語意味
To get started, clone the repository.始めるには、リポジトリをクローンします。
Make sure you have Docker installed.Dockerがインストールされていることを確認してください。
The following command starts the dev server.次のコマンドで開発サーバーが起動します。
This project is still under active development.このプロジェクトは現在も開発中です。
See CONTRIBUTING.md for details.詳しくはCONTRIBUTING.mdを参照してください。
If you find a bug, please open an issue.バグを見つけたら、Issueを作成してください。

書くときのコツ

  • 手順は命令形で短く:「Run」「Install」「Copy」で始めます。
  • 主語の「We」は使いすぎない。「This library ...」「The tool ...」で書くと客観的になります。
  • コマンドはそのままコピーできるようにコードブロックに入れます。

日本語版と英語版を両方用意するには

よくあるのは、英語の README.md をメインにして、日本語版を README.ja.md として置き、それぞれの先頭に「English | 日本語」のリンクを並べる方法です。英語版を先に更新し、日本語版が古くなっていないかを定期的に確認します。

Devlingoで開発現場の英語を1日10フレーズ

Gambit StudioのDevlingo(English for Devs)は、開発者のための英語フレーズアプリです。デイリースタンドアップ、コードレビュー、Slack、プルリクエスト、バグ報告、面接など12カテゴリに3,600以上のフレーズを収録し、1日10個ずつ、使う場面と発音ガイド、例文つきで学べます。ホーム画面ウィジェットには今日のフレーズが表示されます。画面表示は英語などで、日本語には対応していません。

出典

  1. GitHub Docs「リポジトリの README ファイルについて」

よくある質問

よく聞かれる質問に、出典つきで答えます。

READMEは英語と日本語どちらで書くべき?
公開して海外の人にも使ってほしいなら英語がメインです。日本語版を README.ja.md として並べる方法もあります。
READMEに最低限書くことは?
何をするものか、インストール方法、使い方、ライセンスの4つです。
READMEの英語の文体は?
手順は命令形(Run ...、Install ...)、説明は現在形(This tool renames ...)が基本です。
「プルリクエスト歓迎」は英語で?
「Pull requests are welcome.」です。

続けて読む

同じアプリのガイドをもっと。手順と出典つき。

Devlingo無料 · iOS 17.0+
インストールなしで使う入手