ตัวอักษรตัวพิมพ์ใหญ่ทั้งหมดโดดเด่นและทำให้มองเห็นไฟล์ได้ง่ายซึ่งเหมาะสมเนื่องจากอาจเป็นสิ่งแรกที่ผู้ใช้ใหม่ต้องการดู (หรืออย่างน้อยควรดูที่ ... ) ตามที่คนอื่นพูดไปแล้วชื่อไฟล์ที่ขึ้นต้นด้วยตัวอักษรพิมพ์ใหญ่จะแสดงก่อนชื่อตัวพิมพ์เล็กในการเรียงลำดับASCIIbetical ( LC_COLLATE=C) ซึ่งช่วยให้มองเห็นไฟล์ได้อย่างรวดเร็วก่อน
READMEไฟล์ดังกล่าวเป็นส่วนหนึ่งของไฟล์ที่ผู้ใช้แพคเกจซอฟต์แวร์เสรีคาดว่าจะพบได้ตามปกติ อื่น ๆ มีINSTALL(คำแนะนำสำหรับการสร้างและติดตั้งซอฟแวร์) AUTHORS(รายชื่อของผู้ร่วม) COPYING(ข้อความใบอนุญาต) HACKING(วิธีการเริ่มต้นสำหรับการบริจาคอาจจะรวมถึงรายชื่อสิ่งที่ต้องทำของจุดเริ่มต้น) NEWS(การเปลี่ยนแปลงล่าสุด) หรือChangeLog(ส่วนใหญ่ซ้ำซ้อนกับ ระบบควบคุมเวอร์ชัน)
นี่คือสิ่งที่มาตรฐานการเข้ารหัสของ GNUได้กล่าวถึงเกี่ยวกับREADMEไฟล์
การกระจายควรมีไฟล์ชื่อที่READMEมีภาพรวมทั่วไปของแพคเกจ:
- ชื่อของแพ็คเกจ;
- หมายเลขเวอร์ชันของแพ็กเกจหรืออ้างถึงตำแหน่งที่สามารถพบเวอร์ชันของแพ็กเกจ
- คำอธิบายทั่วไปเกี่ยวกับสิ่งที่แพ็คเกจทำ
- การอ้างอิงไปยังไฟล์
INSTALLซึ่งควรจะมีคำอธิบายของขั้นตอนการติดตั้ง;
- คำอธิบายสั้น ๆ เกี่ยวกับไดเรกทอรีหรือไฟล์ระดับสูงผิดปกติหรือคำแนะนำอื่น ๆ สำหรับผู้อ่านในการค้นหาเส้นทางรอบแหล่งที่มา
- การอ้างอิงไปยังไฟล์ที่มีเงื่อนไขการคัดลอก ลิขสิทธิ์ GNU GPL
COPYINGถ้าใช้ควรจะอยู่ในไฟล์ที่เรียกว่า หาก GNU COPYING.LESSERแอลจีที่ใช้ก็ควรจะอยู่ในไฟล์ที่เรียกว่า
เนื่องจากเป็นการดีที่จะพยายามทำให้ผู้ใช้ของคุณประหลาดใจน้อยที่สุดคุณควรปฏิบัติตามอนุสัญญานี้เว้นแต่จะมีเหตุผลที่น่าสนใจสำหรับการเบี่ยงเบน ในโลกของ UNIX ส่วนขยายของชื่อไฟล์นั้นถูกใช้อย่างไม่ต่อเนื่องดังนั้นชื่อมาตรฐานของไฟล์จะREADMEไม่มีคำต่อท้ายใด ๆ แต่ผู้ใช้ส่วนใหญ่คงไม่มีปัญหาในการทำความเข้าใจว่าไฟล์ชื่อREADME.txtมีความหมายเหมือนกัน หากไฟล์ถูกเขียนในMarkdownชื่อไฟล์เช่นREADME.mdนั้นอาจเหมาะสม หลีกเลี่ยงการใช้ภาษามาร์กอัปที่ซับซ้อนยิ่งขึ้นเช่น HTML ในREADMEไฟล์อย่างไรก็ตามเนื่องจากควรจะสะดวกในการอ่านบนเทอร์มินัลข้อความเท่านั้น คุณสามารถชี้ผู้ใช้ไปยังคู่มือของซอฟต์แวร์หรือเอกสารออนไลน์ที่อาจเขียนในรูปแบบที่ซับซ้อนยิ่งขึ้นเพื่อดูรายละเอียดจากREADMEไฟล์