リードミー

リードミー（Readme）とは

リードミー（Readme）とは、ソフトウェアを配布する際に添付される文書ファイルの一つです。これは、配布物の基本的な情報を提供するものであり、多くの場合、ソフトウェアをインストールして使用する前に読むことが推奨されています。リードミーファイルは、ソフトウェアの利用者が最初に目を通すドキュメントとして非常に重要です。

ファイル形式

リードミーファイルは、一般的にはテキスト形式のファイルとして提供されます。しかし、WindowsやmacOSなどのオペレーティングシステムでは、リッチテキストフォーマットが標準でサポートされているため、リッチテキスト形式で提供されることもあります。

記載内容

リードミーファイルに記載される内容は、配布物の情報を網羅的にまとめたものから、最小限の情報だけを記載し、詳細な情報を別のファイルへのポインタで示すものまで様々です。

一般的に記載される内容は以下の通りです。

ソフトウェアの名前
バージョン情報
配布物の概要
ファイル構成
動作環境
インストール方法と簡単な使用方法
作者情報
更新履歴
既知の不具合
トラブルシューティング
謝辞
著作権情報とライセンス情報
（シェアウェアの場合）レジストキーの入手方法、試用期間中の制限事項

ファイル名

リードミーファイルのファイル名は、オペレーティングシステムや文化によって異なります。

MS-DOS・Microsoft Windowsの場合

`README`
`README.TXT`
`README.1ST`
`READ.ME`
`README.DOC`（Microsoft Wordが普及する以前）

日本語で配布されるソフトウェアでは、以下のようなファイル名が用いられることもあります。

`お読みください`
`はじめにお読みください`
`読んでね`

ライブラリやプラグインのように、一つのディレクトリに複数のソフトウェアとリードミーファイルが混在する可能性のあるソフトウェア形態では、一般的なファイル名（`README.TXT`など）を避け、ソフトウェアの固有の名前を基にしたファイル名が用いられます。

例: `HOGE.DLL`に対応するリードミーファイルは`HOGE.TXT`や`HOGE_README.TXT`など

Unix系OSの場合

Unix系のオープンソースパッケージでは、READMEファイルに加えて、以下のファイルも慣例的に用いられます。

`AUTHORS`（作者情報）
`COPYING`または`LICENSE`（ライセンス情報）
`ChangeLog`（変更履歴）
`INSTALL`（インストール方法）
`NEWS`（ユーザー向け情報）
`TODO`（今後行うべきこと）

これらのファイル名は通常大文字で表記され、Windows文化におけるREADMEよりも、より明確に情報を探し出すことができます。

ホスティングサービスでの利用

GitHubなどのコードホスティングサービスでは、プロジェクトのルートディレクトリにある`README`ファイルを特別なものとして扱い、その内容をWeb形式で表示する機能があります。これは、UNIX文化における慣習がもたらした利便性です。

作成方法

リードミーファイルは、テキストエディタで作成するほか、リードミー作成専用のツールを利用して作成することもできます。また、統合開発環境やGNU Autotoolsなどのフレームワークには、リードミーを含むドキュメントを生成する機能が備わっていることが多いです。

関連情報

以下に関連情報を示します。

マニュアル
オンラインソフトウェア
リリースノート
フリーソフトウェア／シェアウェアに添付する文書ガイドライン（電子ネットワーク協議会）

もう一度検索