Readme.txtとREADME.txt
私はちょうどGithubでプロジェクトをforkし、変更を加えたところです。これは私に不思議に思いました：オープンソースプロジェクトにほとんどREADME.txtがあり、編集したファイルはReadme.txtでした。これはある種の標準化ですか、それともそのままにしておくべきですか？
すべて大文字の文字が目立ち、ファイルが見やすくなります。これは、おそらく新しいユーザーが最初に見たいものであるためです。 （または、少なくとも、見るべきです見てください...）他の人がすでに言ったように、大文字で始まるファイル名は小文字の前にリストされます 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のようなファイル名も妥当な場合があります。 READMEファイルでは、HTMLなどのより複雑なマークアップ言語を使用しないでください。テキストのみの端末で読むと便利です。 READMEファイルの詳細については、ソフトウェアのマニュアルまたはより洗練された形式で記述されているオンラインドキュメントをユーザーに示すことができます。
伝統的に、ファイルはREADME大文字で呼ばれていました。コマンドライン環境ではアルファベット順を使用するため、ファイルが一番上に置かれるため、大きなディレクトリで簡単に見えるようになります。
ソースをダウンロードしてソフトウェアをビルドする、Unix/Linuxの世界からの持ち越しである可能性が高いです。 「リストディレクトリの内容」ビューの上部にREADMEおよびINSTALLのようなファイルがあると、コマンドラインインターフェイスから内容全体を参照する必要がなく、ファイルがそこにあることを簡単に確認できます。 。同じ基本原理がgithubでも機能します（実際にはGUIインターフェースでも機能します。考えてみると、メリットがあるかもしれません）。
決して難しい規則ではありませんが、他のプロジェクトがそれを行っているために、誰もが習慣としてしている可能性が非常に高いです。明確な理由がない限り、他の多くのプロジェクトでそのように使用されていることがわかるだけで、おそらくすべて大文字にする必要があります。これは、新しいリポジトリを作成するときにGithubが使用するデフォルトの命名でもあります。
READMEは通常大文字で書かれています。このように、ls Unixコマンドは、ファイルをディレクトリリストの先頭近くに配置しました（大文字は、ASCIIの順序で小文字の前に来る）。