Readmeファイル

概要

Readmeファイルとは、ソフトウェアの配布パッケージに添付される文書ファイルの一種で、最初に必ず読んでほしい内容を記載したもの。テキスト形式のものは特に「Readme.txt」というファイル名になっている。オンラインで配布・販売されるパッケージに添付されることが多い。

何を記入するかは開発者によって異なるが、利用者に最初に伝達したいソフトウェアの導入方法や基本的な操作方法、旧版との違い、注意事項、免責事項などが記載されていることが多い。“Read me.” とは「私を読んで」という英文で、ファイル名だけで利用者に閲覧すべきファイルであることを伝達するため、このような名前が慣習的に用いられている。

Readmeファイル自体をソフトウェアについて網羅的に詳細を記した文書とする場合もあり、ファイル構成や動作環境、過去の更新履歴、既知の不具合や制限事項、よくある問題の解決法（トラブルシューティング）、開発者についての情報（著作権表示や連絡先など）、謝辞、ライセンス（利用許諾）情報などが記載される。

物理的なパッケージで販売される商用ソフトウェアの場合はプログラム本体を記録した記憶媒体の他に冊子や書類を添付できるため、そこに注意事項などを記載するのが一般的だが、フリーソフトウェアやシェアウェア、オープンソースソフトウェア、商用ソフトウェアのダウンロード販売などの場合は物理的な媒体が無いため、プログラムファイルと一緒にReadmeファイルを添付して書類の代替としている。

利用者の環境によらず内容を読むことができるよう、OS標準のメモ帳アプリなどで開くことができるテキスト形式の「Readme.txt」が用いられることが多いが、ソフトウェア開発者向けのツールなどではMarkdown形式の「Readme.md」なども頻繁に用いられる。

この記事の著者 ： (株)インセプト IT用語辞典 e-Words 編集部
1997年8月より「IT用語辞典 e-Words」を執筆・編集しています。累計公開記事数は1万ページ以上、累計サイト訪問者数は1億人以上です。学術論文や官公庁の資料などへも多数の記事が引用・参照されています。