সমস্ত-বড় হাতের অক্ষরগুলি আলাদা হয়ে যায় এবং সহজেই ফাইলটি দৃশ্যমান হয় যা বোঝায় যেহেতু এটি সম্ভবত প্রথম কোনও নতুন ব্যবহারকারীকে দেখতে চাইবে। (বা, কমপক্ষে, দেখে নেওয়া উচিত ...) অন্যরা যেমন বলেছে, বড় বড় অক্ষর দিয়ে শুরু হওয়া ফাইলের নামগুলি ASCIIbetical বাছাইয়ের ক্ষেত্রে ছোট-বড় নামগুলির আগে তালিকাভুক্ত করা হবে ( LC_COLLATE=C) যা ফাইলটিকে প্রথম নজরে দৃশ্যমান করতে সহায়তা করে।
READMEফাইল ফাইল মুক্ত সফটওয়্যার প্যাকেজের একটি ব্যবহারকারী স্বাভাবিকভাবে এটি আশা একটি গুচ্ছ অংশ। অন্যগুলি হ'ল INSTALL(সফটওয়্যারটি তৈরি এবং ইনস্টল করার জন্য নির্দেশাবলী), AUTHORS(অবদানকারীদের তালিকা), COPYING(লাইসেন্সের পাঠ্য), HACKING(কীভাবে অবদানের জন্য শুরু করা যেতে পারে, সম্ভবত পয়েন্টগুলির একটি টোডো তালিকা সহ), NEWS(সাম্প্রতিক পরিবর্তনগুলি) বা ChangeLog(বেশিরভাগ ক্ষেত্রে অপ্রয়োজনীয় সংস্করণ নিয়ন্ত্রণ সিস্টেম)।
এই কি গনুহ কোডিং স্ট্যান্ডার্ড সম্পর্কে কী বলার আছে READMEফাইল।
বিতরণে READMEপ্যাকেজের সাধারণ ওভারভিউ সহ একটি ফাইল থাকা উচিত :
- প্যাকেজের নাম;
- প্যাকেজের সংস্করণ নম্বর, বা প্যাকেজে সংস্করণটি কোথায় পাওয়া যাবে তা উল্লেখ করুন;
- প্যাকেজটি কী করে তার একটি সাধারণ বিবরণ;
- ফাইলটির একটি রেফারেন্স
INSTALL, যার মধ্যে ইনস্টলেশন পদ্ধতির ব্যাখ্যা থাকতে হবে;
- উত্সের চারপাশে কোনও উপায় খুঁজে পাওয়ার জন্য কোনও অস্বাভাবিক শীর্ষ-স্তরের ডিরেক্টরি বা ফাইলগুলির বা পাঠকদের জন্য অন্যান্য ইঙ্গিতগুলির সংক্ষিপ্ত বিবরণ;
- ফাইলটিতে একটি অনুলিপি যা অনুলিপি করার শর্তাদি অন্তর্ভুক্ত করে। জিএনইউ জিপিএল, যদি ব্যবহৃত হয় তবে একটি ফাইল করা উচিত
COPYING। যদি জিএনইউ এলজিপিএল ব্যবহার করা হয় তবে এটি একটি ফাইল করা উচিত COPYING.LESSER।
যেহেতু আপনার ব্যবহারকারীদের সর্বনিম্ন আশ্চর্য হওয়ার জন্য সর্বদা চেষ্টা করা ভাল, তাই কোনও বিচ্যুতির কারণী কারণ না থাকলে আপনার এই সম্মেলনটি অনুসরণ করা উচিত। ইউনিক্স বিশ্বে ফাইলের নাম এক্সটেনশনগুলি প্রচলিতভাবে স্বল্প পরিমাণে ব্যবহার করা হত সুতরাং ফাইলটির নামটি READMEকোনও প্রত্যয় ছাড়াই থাকে। তবে বেশিরভাগ ব্যবহারকারীদের সম্ভবত বুঝতে কোনও সমস্যা হবে না যে নামের একটি ফাইলের README.txtএকই অর্থ রয়েছে। ফাইলটি যদি ডাউনডাউন লিখিত থাকে তবে ফাইলের মতো নামও README.mdযুক্তিসঙ্গত হতে পারে। এইচটিএমএল এর মতো আরও জটিল মার্কআপ ভাষা ব্যবহার করা এড়িয়ে চলুন AvoREADMEফাইল, তবে এটি কেবল পাঠ্য টার্মিনালে পড়ার সুবিধার্থে হওয়া উচিত। আপনি ব্যবহারকারীদের সফ্টওয়্যারটির ম্যানুয়াল বা তার অন-লাইন ডকুমেন্টেশনের দিকে নির্দেশ করতে পারেন, এটি READMEফাইল থেকে বিশদগুলির জন্য আরও পরিশীলিত বিন্যাসে লেখা যেতে পারে ।