讀我檔案(英文:Readme)是一種說明文件,通常隨著一個軟件而發佈,裡面記載有軟件的描述或注意事項。這種檔案通常是一個純文字文件,被命名README.TXT、README.1ST或READ.ME等等;但也有RTF或DOC格式的讀我檔案。它的檔名通常是以大写英文來命名的,因為大写英文字母比小写有著較小的ASCII碼;亦因此在一些以ASCII排序檔案的環境裡,它能被保證被列在檔案列表的第一位。這種檔案的特殊命名使任何人也能第一時間發現並閱讀這個檔案,即使他們本身並沒有關於讀我檔案的相關知識。 檔案的內容通常有以下的資訊:
- 設置指引
- 安裝指引
- 操作指引
- 檔案列表(隨著軟件而發佈的檔案)
- 版權聲明
- 軟件作者的聯絡方法
- 已知臭蟲
- 疑難排解
- 鳴謝
- 更新記錄
讀我檔案有時也會被用來形容一些提供資訊的檔案,雖然他們的名字不是讀我或是Readme,但卻包含上面所提及的,讀我檔案的普遍內容。一些開放源碼程式,特別是以GNU建構系統打包的檔案,通常會包含以下幾種檔案:
- README:一般資訊
- AUTHORS:參考
- THANKS:鳴謝
- ChangeLog:更新記錄,通常為程序員而設
- NEWS:更新記錄,但專為使用者而設
- INSTALL:安裝指引
- COPYING:版權聲明
- BUGS:已知臭蟲,亦包括回報臭蟲的方法[1]
- FAQ:有關軟件的問答[1]
- TODO:更新預告
參考資料 [编辑]
- ^ 1.0 1.1 Manes, Stephen. README? Sure--before I buy!. PC World. 1996.November, 14 (11): p366.