README file

名詞

Unixのソース配布物のトップレベルディレクトリに伝統的に含まれる、ハッカー目線の入門書。より詳細なドキュメントへのポインタ、クレジット、雑多な改訂履歴、注記などを含む。MacやPCの世界では、ソフトウェアは通常ソース形式では配布されず、READMEには土壇場のドキュメント変更、エラー回避策、制限といったユーザー向けの内容が含まれることが多い。尋ねると、ハッカーは決まってREADMEの慣習を、Lewis Carrollの『不思議の国のアリス』(Alice's Adventures In Wonderland)で、アリスが「Eat Me」「Drink Me」と書かれた魔法の食べ物に遭遇する有名な場面と結びつける。

そのファイルはREADME、あるいはREAD.ME、まれにReadMeやreadme.txtなどの変種で名付けられることもある。だが全部大文字の綴りは、Unixプログラマの間では普遍的である。古来の伝統により、本物のソースファイルはすべて小文字の名前を持ち、全部大文字はメタデータ、コメント、落書きのために予約されている。これは実用的だ。ASCIIでは「A」が「a」より前にソートされるため、READMEはディレクトリ一覧でどのソースファイルよりも前に現れるのである。