Readme.txtとREADME.txtの比較

大文字はすべて目立ち、ファイルが見やすくなります。これは、おそらく新しいユーザーが最初に見たいと思うものだからです。 （または、少なくとも を確認する必要があります…）他の人がすでに言っているように、 ASCIIbetical 並べ替え（LC_COLLATE=C）。ファイルを一目で確認できます。

READMEファイルは、フリーソフトウェアパッケージのユーザーが通常見つけることを期待する一連のファイルの一部です。その他には、INSTALL（ソフトウェアのビルドとインストールの手順）、AUTHORS（寄稿者のリスト）、COPYING（ライセンステキスト）、HACKING（貢献を開始する方法、開始点のTODOリストを含む場合があります）、NEWS（最近の変更）またはChangeLog（バージョン管理システムではほとんど冗長）。

これはです。 GNUコーディング標準 は、READMEファイルについて言及する必要があります。

ディストリビューションには、パッケージの一般的な概要を含むREADMEという名前のファイルが含まれている必要があります。

• パッケージの名前;
• パッケージのバージョン番号、またはパッケージ内のどこにバージョンがあるかを参照します。
• パッケージの機能の一般的な説明。
• ファイルへの参照INSTALL、これはturにあるはずですnインストール手順の説明が含まれています。
• 異常なトップレベルのディレクトリやファイルの簡単な説明、または読者がソースを回避するためのその他のヒント。
• aコピー条件を含むファイルへの参照。 GNU GPLを使用する場合は、COPYINGというファイルに含める必要があります。 GNU LGPLを使用する場合は、COPYING.LESSERというファイルに含める必要があります。

ユーザーの驚きを最小限に抑えるように努力することは常に良いことなので、逸脱のやむを得ない理由がない限り、この規則に従う必要があります。 UNIXの世界では、ファイル名拡張子は従来は控えめに使用されていたため、ファイルの正規名はREADMEでサフィックスはありません。しかし、ほとんどのユーザーは、README.txtという名前のファイルが同じ意味を持っていることを理解するのに問題はないでしょう。ファイルが マークダウン で記述されている場合、README.mdのようなファイル名もリーズナブル。ただし、READMEファイルでHTMLなどのより複雑なマークアップ言語を使用することは避けてください。テキストのみの端末で読むと便利なため、 READMEファイルの詳細については、より洗練された形式で記述されている可能性のあるソフトウェアのマニュアルまたはそのオンラインドキュメントをユーザーに示すことができます。

アルファベット順を使用するコマンドライン環境ではファイルが先頭に配置されるため、従来、ファイルは大文字でREADMEと呼ばれていました。これにより、大きなディレクトリで簡単に表示できます。

これは、ソースをダウンロードしてソフトウェアをビルドするUnix / Linuxの世界からの引き継ぎである可能性が高いです。「ディレクトリの内容のリスト」ビューの上部にREADMEやINSTALLなどのファイルがあると、コマンドラインインターフェイスからコンテンツ全体を参照する代わりに、そこにあることを簡単に確認できます。同じ基本原則がgithubでも機能します（実際にはGUIインターフェイスでも機能するので、考えてみてください。まだメリットがあります）

決して難しいルールではありませんが、他のプロジェクトがそれを行っているため、誰もが習慣として行っている可能性が非常に高いです。そうしない明確な理由がない限り、おそらくすべてを使用する必要があります他の多くのプロジェクトでそのように使用されていることがわかるからです。これは、新しいリポジトリを作成するときにGithubが使用するデフォルトの名前でもあります。

コメント

• I ' veは常に、大文字のセクションが法律用語であるのと同じように、すべて大文字が強調の形式であると考えていました。
• コマンドラインインターフェイスでは、リストの一番上にあるファイルは実際には最初にスクロールして表示されないファイルであるため、これらのファイルが最も目立たない場合があります。 常にls -l | lessのようなことをしない限り。

READMEは通常大文字で書かれています。 このようにして、ls Unixコマンドは、ファイルをディレクトリリストの先頭近くに配置しました（ASCII順序では、大文字が小文字の前に表示されます）。

コメント

• これは歴史的な理由でしたが、lsは' t 通常、最近のシステムではそのように並べ替えます。
• @ dan1111そうです！ ありがとうございます（試してみてください… LC_COLLATE="en_US.ascii" ; ls -lとLC_COLLATE="en_US.UTF-8" ; ls -l）