回答:
大文字がすべて目立つため、ファイルを簡単に表示できます。これは、おそらく新しいユーザーが最初に見たいと思うことになるためです。(または、少なくとも、見ておくべきでした...)他の人がすでに言ったように、大文字で始まるファイル名はASCIIbeticalソート(LC_COLLATE=C
)で小文字名の前にリストされ、一目でファイルを見えるようにします。
このREADME
ファイルは、フリーソフトウェアパッケージのユーザーが通常見つけることを期待する一連のファイルの一部です。その他にはINSTALL
、AUTHORS
(ソフトウェアのビルドとインストールの手順)、(貢献者のリスト)、COPYING
(ライセンステキスト)、HACKING
(おそらく開始点のTODOリストを含む、貢献の開始方法)、NEWS
(最近の変更)、またはChangeLog
(ほとんどが冗長です)バージョン管理システム)。
これは、GNUコーディング標準がREADME
ファイルについて述べなければならないことです。
ディストリビューションには
README
、パッケージの一般的な概要が記載されたファイルが含まれている必要があります。
- パッケージの名前。
- パッケージのバージョン番号、またはパッケージ内のどこにバージョンがあるかを参照します。
- パッケージの機能の一般的な説明。
- ファイルへの参照に
INSTALL
は、インストール手順の説明が含まれている必要があります。- 異常なトップレベルのディレクトリまたはファイルの簡単な説明、または読者がソースを回避するためのその他のヒント。
- コピー条件を含むファイルへの参照。GNU GPLを使用する場合は、というファイルに含める必要があります
COPYING
。GNU LGPLを使用する場合は、というファイルにある必要がありますCOPYING.LESSER
。
ユーザーの驚かないように努力することは常に良いことなので、逸脱の説得力のある理由がない限り、この規則に従うべきです。UNIXの世界では、ファイル名拡張子は伝統的に控えめに使用されていたため、ファイルの正規名にはREADME
接尾辞がありません。しかし、ほとんどのユーザーはおそらく、指定されたファイルREADME.txt
が同じ意味を持っていることを理解することに問題はないでしょう。ファイルがMarkdownで記述されている場合、次のようなファイル名README.md
も妥当です。HTMLのようなより複雑なマークアップ言語の使用は避けてくださいREADME
ただし、ファイルはテキストのみの端末で読むと便利なはずです。README
ファイルの詳細については、より洗練された形式で記述されている可能性のあるソフトウェアのマニュアルまたはオンラインドキュメントをユーザーに示すことができます。
従来、ファイルは大文字でREADMEと呼ばれていました。これは、アルファベット順を使用するコマンドライン環境がファイルを先頭に配置するためです。これにより、大きなディレクトリに簡単に表示されます。
これはおそらく、ソースをダウンロードしてからソフトウェアをビルドするUnix / Linuxの世界から持ち越されたものです。「ディレクトリコンテンツの一覧」ビューの上部にREADMEやINSTALLなどのファイルがあると、コマンドラインインターフェイスからコンテンツ全体を参照する代わりに、それらがそこにあることが簡単にわかります。同じ基本原則はgithubでも機能します(実際にはGUIインターフェースでも機能しますが、考えてみるとメリットがあります)
決して厳しいルールではありませんが、他のプロジェクトがそれをやっているので、誰もが習慣としてやっている可能性が非常に高いです。しない明確な理由がない限り、他の多くのプロジェクトでそのように使用されていることがわかるからといって、おそらくすべて大文字を使用するべきです。また、新しいリポジトリを作成するときにGithubが使用するデフォルトの命名法です。
ls -l | less
。