ऑल-अपरकेस अक्षर बाहर खड़े होते हैं और फ़ाइल को आसानी से दिखाई देते हैं जो समझ में आता है क्योंकि यह शायद पहली चीज है जिसे एक नया उपयोगकर्ता देखना चाहेगा। (या, कम से कम, देखा जाना चाहिए ...) जैसा कि दूसरों ने पहले ही कहा है, कैपिटल लेटर से शुरू होने वाले फ़ाइल नामों को ASCIIbetical सॉर्टिंग ( LC_COLLATE=C) में कम-केस नामों से पहले सूचीबद्ध किया जाएगा जो फ़ाइल को पहली नज़र में दिखाई देने में मदद करता है।
READMEफ़ाइल फ़ाइलें एक नि: शुल्क सॉफ्टवेयर पैकेज का एक उपयोगकर्ता सामान्य रूप से खोजने के लिए उम्मीद करेंगे के एक झुंड का हिस्सा है। अन्य हैं INSTALL(सॉफ़्टवेयर के निर्माण और स्थापना के लिए निर्देश), AUTHORS(योगदानकर्ताओं की सूची), COPYING(लाइसेंस पाठ), HACKING(योगदान करने के लिए कैसे शुरू करें, शायद शुरुआती बिंदुओं की एक TODO सूची सहित), NEWS(हाल ही में परिवर्तन) या ChangeLog(ज्यादातर के साथ बेमानी ) संस्करण नियंत्रण प्रणाली)।
यह जीएनयू कोडिंग मानकों का READMEफाइल के बारे में कहना है ।
वितरण READMEमें पैकेज के सामान्य अवलोकन के साथ एक फाइल होनी चाहिए :
- पैकेज का नाम;
- पैकेज की संस्करण संख्या, या पैकेज में जहां संस्करण पाया जा सकता है को देखें;
- पैकेज क्या करता है का एक सामान्य विवरण;
- फ़ाइल का संदर्भ
INSTALL, जिसमें बदले में स्थापना प्रक्रिया का स्पष्टीकरण होना चाहिए;
- स्रोत के आसपास अपना रास्ता खोजने के लिए पाठकों के लिए किसी भी असामान्य शीर्ष-स्तरीय निर्देशिकाओं या फ़ाइलों, या अन्य संकेतों का संक्षिप्त विवरण;
- फ़ाइल में एक संदर्भ जिसमें प्रतिलिपि स्थितियाँ शामिल हैं। जीएनयू जीपीएल, यदि उपयोग किया जाता है, जिसे एक फ़ाइल में बुलाया जाना चाहिए
COPYING। यदि जीएनयू एलजीपीएल का उपयोग किया जाता है, तो इसे एक फाइल में बुलाया जाना चाहिए COPYING.LESSER।
चूंकि अपने उपयोगकर्ताओं के कम से कम आश्चर्य के लिए प्रयास करना हमेशा अच्छा होता है, इसलिए आपको इस सम्मेलन का पालन करना चाहिए जब तक कि विचलन के लिए आकर्षक कारण न हों। UNIX दुनिया में, फ़ाइल नाम एक्सटेंशन को पारंपरिक रूप से उपयोग किया जाता था इसलिए फ़ाइल का विहित नाम READMEबिना किसी प्रत्यय के है। लेकिन अधिकांश उपयोगकर्ताओं को शायद यह समझने में कोई परेशानी नहीं होगी कि नाम वाली फ़ाइल README.txtका एक ही अर्थ है। यदि फ़ाइल मार्कडाउन में लिखी जाती है , तो फ़ाइल नाम README.mdभी उचित हो सकता है। HTML में अधिक जटिल मार्कअप भाषाओं का उपयोग करने से बचेंREADMEफ़ाइल, हालांकि, क्योंकि यह केवल-पाठ टर्मिनल पर पढ़ने के लिए सुविधाजनक होना चाहिए। आप उपयोगकर्ताओं को सॉफ़्टवेयर के मैनुअल या इसके ऑन-लाइन प्रलेखन के लिए इंगित कर सकते हैं, जो READMEफ़ाइल से विवरण के लिए अधिक परिष्कृत प्रारूप में लिखा जा सकता है ।