Loading article…
ソフトウェアの配布や開発において、README ファイルには、コンピュータソフトウェアのディレクトリまたはアーカイブ内の他のファイルに関する情報が含まれています。ドキュメントの形式であり、通常は、、、、[1]または（Markdownの使用を示す）
と呼ばれる単純なプレーンテキストファイルです。READMERead MeREAD.MEREADME.txtREADME.md
ファイル名は、通常、大文字で記述されます。特にUnix 系システムでは、小文字のファイル名の方が一般的であることと、コマンドがASCII コード順lsにファイルをソートして表示し、大文字のファイル名が最初に表示されることから、ファイル名が目立つようになります。[nb 1]
コンテンツ
README ファイルには通常、次の内容が含まれます。
- 設定手順
- インストール手順
- 操作手順
- ファイルマニフェスト(ディレクトリまたはアーカイブ内のファイルのリスト)
- 著作権とライセンス情報
- 販売元または著者の連絡先情報
- 既知のバグのリスト[2]
- トラブルシューティング手順[2]
- クレジットと謝辞
- 変更履歴（通常はプログラマー仲間向け）
- ニュースセクション（通常はエンドユーザー向け）
歴史
READMEファイルを同梱する慣習は1970年代半ばに始まりました。[3] [4] [5] [6] [7] [8] [9]初期のMacintoshシステムソフトウェアは起動ディスクにRead Meをインストールし、READMEファイルはサードパーティのソフトウェアに付属するのが一般的でした。
特に、フリーソフトウェアやオープンソースソフトウェアにはREADMEファイルが含まれている長い歴史があり、GNUコーディング標準では「パッケージの概要」を提供するためにREADMEファイルを含めることを推奨しています。[10]
ソフトウェア配布の事実上の標準プラットフォームとしてWebが登場して以来、多くのソフトウェア パッケージは上記の補助ファイルや情報の一部をWeb サイトやwikiに移動 (またはコピー) しており、README 自体が含まれる場合もあれば、ソフトウェアの新規ユーザーが必要とするすべての情報を含まない短い README ファイルだけが残されている場合もあります。
人気のソースコードホスティングウェブサイトGitHubはREADMEファイルの作成を強く推奨しています。リポジトリのメイン（最上位）ディレクトリにREADMEファイルが存在する場合、リポジトリのフロントページに自動的に表示されます。[11]プレーンテキストに加えて、さまざまな他の形式とファイル拡張子もサポートされており、[12] HTML変換では拡張子が考慮されます。特に、はGitHub Flavored MarkdownREADME.mdとして扱われます。
一般的な用語として
「readme ファイル」という表現は、同様の目的を持つ他のファイルに対して、一般的な意味で使われることもあります。[要出典]たとえば、多くのフリー ソフトウェア パッケージ (特にGnits 標準に準拠したものやGNU Autotoolsで作成されたもの)のソース コード配布には、標準的な readme ファイルのセットが含まれています。
また、ソフトウェア パッケージには、FAQファイルやTODO計画されている改善点をリストしたファイルも一緒に配布されることが一般的です。
参照
注記
- ^ これはもはや当てはまらない場合が多いですが、LC_ALL=C ls は古い動作を示します。
参考文献
- ^ レイモンド、エリック・スティーブン(1996)。『新ハッカー辞典』。MIT出版。pp . 378–79。ISBN 978-0-26268092-9.
ハッカーの視点からの紹介文で、Unix ソース ディストリビューションの最上位ディレクトリに伝統的に含まれており、より詳細なドキュメント、クレジット、さまざまな改訂履歴、注記などへのポインタが含まれています。 […] ハッカーに尋ねられると、README 規則は必ず、ルイス キャロルの『不思議の国のアリス』でアリスが「私を食べて」や「私を飲んで」と書かれた魔法のお菓子と対峙する有名なシーンに関連づけられます。
- ^ ab Manes, Stephen (1996 年 11 月)。「README? 購入する前に必ず読んでください!」PC World . 14 (11): 366。
- ^ 「PDP-10 アーカイブ: decus/20-0079/readme.txt from decus_20tap3_198111」。pdp -10.trailing- edge.com。1974-11-27。2018-03-03に取得。 [README.TXT は SPICE/SINC/SLIC の DOC ファイルです] このフェイルセーフ テープには、Applications Software Bulletin Volume 4 に記載されている回路解析プログラム SPICE SINC および SLIC が含まれています。
要件: SPICE は、右調整ホレリス データを使用するため、FORTRAN-10 バージョン 4 が必要です。約 47K で実行されます。[…] また、このファイル、SAV に付随する FOROTS、およびタイミング ルーチン SECOND.MAC のソースも含まれています。SPICE は、1SPICE.FOR、2、3 の 3 つの部分に分かれています。各プログラムを説明する印刷されたドキュメントがあります。これらは DECUS パケットに含まれています。ドキュメントとプログラムは、もともとカリフォルニア大学バークレー校の電気工学部が CDC 6400 で開発したものです。FORTRAN を DECsystem-10 に変換する以外は、プログラムに変更は加えられていません。テスト データでは、SLIC と SINC は 6400 と比べて若干の差が見られましたが、SPICE では差は見られませんでした。幸運を祈ります! Ashley Grayson 1974 年 11 月 27 日 [README.TXT の終了]
- ^ 「DECUS 10-LIB-4 には、10-223 を除く 10-210 から 10-241 が含まれています」 。pdp -10.trailing- edge.com 。1975 年 3 月 27 日。2018 年 3 月 3 日に取得。
この FAILSAFE テープ上のファイルは、UCI LISP システムを構成します。それらのほとんどは、カリフォルニア州アーバインにあるカリフォルニア大学情報コンピューター科学部から入手できる UCI LISP マニュアルに記載されています。
[1] - ^ 「Programmer's Workbench /sys/source/lex/README」。1977年7月。 2020年1月25日閲覧。
- ^ 「Unix 7th edition /usr/doc/README」 1979年. 2020年1月25日閲覧。
- ^ 「最初の 32 ビット BSD usr/doc/README」。1980 年 3 月。2020 年 1 月 25 日閲覧。
- ^ Langemeier, Jeff (2011-07-29). 「Re: README の起源」。2020-01-25に取得– Stackexchange 経由。
[…] 彼らは、パンチ カードや磁気テープ、その他「プログラム」とされるほぼすべてのものに README (実際の物理的な印刷ファイル) を用意していました。当時は、作成、実行、その他すべてに手間のかかるプロセスがあったため、README が本当に必要でした。これらの README には、エラー チェックとデバッグの一形態として、パンチ カードのパンチ方法の実際のプリントアウトも含まれていました。この慣習は、パンチ カードすべてに、README という大文字の文言が印刷された「リーム」の紙が添付されているという点で、古いシステムに従っているようです。これには、パンチ カードの使用方法とシステムへのロードに関するすべての手順が記載されていました。時間的な参考として、これは 60 年代のことだったでしょう。 […]
- ^ Abdelhafith, Omar (2015-08-13). 「README.md: History and Components」。2020年1月25日時点のオリジナルよりアーカイブ。2020年1月25日閲覧。
- ^ 「GNU コーディング標準: リリース」www.gnu.org . 2018 年 3 月 3 日閲覧。
- ^ 「README について」 。GitHub Docs。2024年 5 月 31 日閲覧。
- ^ 「マークアップ」。GitHub。2014年12月25日。2015年2月8日閲覧。
さらに読む
- ジョンソン、マーク (1997-02-01)。 「より良い ReadMe の作成」。テクニカル コミュニケーション。44 (1)。テクニカル コミュニケーション協会: 28–36。JSTOR 43089849。[2][3]
- Rescigno, Jeanne (1997 年 8 月)。「README ファイルにはハイパーテキストが最適」。技術コミュニケーション44 (3)。技術コミュニケーション協会: 214。JSTOR 43089876 。
- Livingston, Brian (1998-09-14). 「Windows の一般的な問題を回避するには、Readme ファイルを確認してください」。InfoWorld。第 20 巻、第 37 号。InfoWorld Media Group, Inc. p. 34。2006-11-18 にオリジナルからアーカイブ。2019-06-04に取得。[4]
- ベンジャミン、アンドリュー(1996-09-15) [1993]。英国ウォーリック大学哲学科で執筆。ジャン＝クロード・ゲドン(編)。「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に取得。[5]
この記事は、パブリック ドメインのJargon Fileに一部基づいています。