README

README ファイルには、そのファイルが配置されているディレクトリの内容に関する説明情報が含まれています。情報の範囲は通常、ディレクトリ内のファイルを含み、子孫ディレクトリやディレクトリツリー全体を含む場合もあります。この名前は、ディレクトリの内容に関する重要かつ方向を示す情報にユーザーの注意を引くことを目的としています。ディレクトリの内容に慣れていない人に対する経験則としては、他のファイルを読む前に README ファイルを読むことです。README という名前がよく使われますが、「Read Me」や「READ.ME」など、同じ目的で使用される類似の名前が他にもたくさんあります。ファイル名には、プレーンテキストの場合は「README.txt」、 Markdownの場合は「README.md」のように、ファイル形式を示す拡張子が含まれる場合もあります。^{[ 1 ]}ファイル名は、多くの場合すべて大文字です。

アーカイブ内のREADMEファイルは、ディレクトリ内のREADMEファイルと同じように機能します。なぜなら、アーカイブは単一ファイルとして保存されるディレクトリのようなものだからです。

標準化されていないため、READMEファイルの形式と内容は大きく異なります。ソフトウェアプロジェクトの場合、READMEファイルには一般的に次のような情報が含まれます。

• 設定手順
• インストール手順
• 操作説明書
• ファイルマニフェスト（ディレクトリまたはアーカイブ内のファイルの一覧）
• 著作権およびライセンス情報
• 販売元または著者の連絡先情報
• 既知のバグのリスト^{[ 2 ]}
• トラブルシューティング手順^{[ 2 ]}
• 謝辞​​
• 変更履歴（通常は同僚のプログラマー向け）
• ニュースセクション（通常はエンドユーザー向け）

README ファイルを含める慣習は 1970 年代半ばに始まりました。^{[ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ]} Unixでは、ほとんどのファイル名が小文字でしたが、目立つように名前を大文字にして ASCII 順のリストの先頭付近に表示するようにしました^。初期のMacintosh システム ソフトウェアは起動ディスクに Read Me をインストールし、README ファイルはサードパーティ ソフトウェアによく付属していました。

特に、フリーソフトウェアやオープンソースソフトウェアにはREADMEファイルが含まれている長い歴史があり、GNUコーディング標準では「パッケージの概要」を提供するためにREADMEファイルを含めることを推奨しています。^{[ 10 ]}

ソフトウェア配布の事実上の標準プラットフォームとしてウェブが登場して以来、多くのソフトウェアパッケージは、上記の補助ファイルや情報の一部をウェブサイトやウィキに移動（または時折コピー）しており、README自体が含まれる場合もあれば、ソフトウェアの新規ユーザーが必要とするすべての情報が含まれていない簡潔なREADMEファイルだけが残されている場合もあります。

人気のソースコードホスティングWebサイトであるGitHubは、READMEファイルの作成を強く推奨しています。リポジトリのメイン（トップレベル）ディレクトリにREADMEファイルが存在する場合、リポジトリのフロントページに自動的に表示されます。^{[ 11 ]}プレーンテキストに加えて、さまざまな他の形式やファイル拡張子もサポートされており、^{[ 12 ]} HTML変換では拡張子が考慮されます。特にREADME.mdはGitHub Flavored Markdownとして扱われます。  

ディレクトリ コンテンツのメタデータは、README に加えて、または README の代わりにファイルに保存されることがあります。^{[ 13 ]}次の表は、一般的に使用されるファイル名と、そのファイルに一般的に含まれる内容を一覧にしたものです。README と同様に、ファイル名やその内容を規定する正式な標準はありません。ただし、Gnits StandardsおよびGNU Autotoolsによって規定される慣習は存在します。

• ファイルID.DIZ
• 説明
• .info
• マニュアルページ
• robots.txt

• Johnson, Mark (1997-02-01). 「より良い ReadMe の構築」. Technical Communication . 44 (1). Society for Technical Communication : 28– 36. JSTOR 43089849 . 
• Rescigno, Jeanne (1997年8月)「READMEファイルにはハイパーテキストが最適」テクニカルコミュニケーション44 (3) 214.JSTOR 43089876 . 
• リビングストン、ブライアン (1998年9月14日)。「 Windowsでよくある問題を回避するためにReadmeファイルを確認してください」。InfoWorld 。第20巻、第37号。InfoWorld Media Group, Inc. 、 34ページ。2006年11月18日のオリジナルからアーカイブ。 2019年6月4日取得。   
• Benjamin, Andrew (1996-09-15) [1993 ] .英国ウォーリック大学哲学部にて執筆。 Guédon, Jean-Claude (編)。「Readme: Writing Notes - Meditations on the temporality of writing」。Surfaces (電子ジャーナル) (英語とフランス語)。III (12)。モントリオール大学、モントリオール (ケベック州)、カナダ: Les Presses de l'Université de Montréal : 1– 12。ISSN 1188-2492。2006-02-20のオリジナルからアーカイブ。2019-06-04に取得。 Wayback Machineに2006年9月19日にアーカイブされました

この記事は、パブリックドメインにある「Jargon File」の一部に基づいています。