ما هو ملف README؟

يُعد ملف README (اقرأني) بمثابة الواجهة التعريفية لأي مجلد أو مشروع برمجِي، حيث يحتوي على معلومات وصفية توضح محتويات المجلد الذي يتواجد فيه الملف. يهدف هذا الملف إلى جذب انتباه المستخدم إلى المعلومات الأساسية والتوجيهية، مما يجعله النقطة الأولى التي يجب على أي شخص غير مطلع على المشروع قراءتها قبل البدء في استكشاف الملفات الأخرى.

أشكال وتنسيقات ملف README

على الرغم من أن الاسم الأكثر شيوعاً هو README، إلا أن هناك تسميات أخرى تؤدي نفس الغرض مثل "Read Me" أو "READ.ME". وغالباً ما يتم كتابة الاسم بأحرف كبيرة (All Caps) لتمييزه. كما تختلف الامتدادات حسب تنسيق الملف، ومن أشهرها:

• README.txt: للنصوص البسيطة.
• README.md: لتنسيق Markdown، وهو الأكثر شيوعاً في المشاريع الحديثة.

يعمل ملف README في الأرشيفات (المضغوطة) بنفس الطريقة التي يعمل بها في المجلدات العادية، حيث يُعتبر الأرشيف وظيفياً كمجلد مخزن في ملف واحد.

محتويات ملف README

بسبب غياب معايير موحدة، يختلف محتوى وتنسيق ملف README بشكل كبير من مشروع لآخر. ومع ذلك، في المشاريع البرمجية، يتضمن الملف عادةً المعلومات التالية:

• تعليمات التكوين (Configuration): كيفية ضبط إعدادات البرنامج.
• تعليمات التثبيت (Installation): الخطوات اللازمة لتشغيل البرنامج لأول مرة.
• تعليمات التشغيل (Operating Instructions): كيفية استخدام البرنامج.
• بيان الملفات (File Manifest): قائمة بالملفات الموجودة في المجلد أو الأرشيف.
• حقوق الطبع والنشر والترخيص: معلومات حول كيفية استخدام وتوزيع البرنامج.
• معلومات الاتصال: بيانات التواصل مع المطور أو الموزع.
• قائمة بالأخطاء المعروفة (Known Bugs): تنبيهات حول مشاكل تقنية موجودة حالياً.
• تعليمات استكشاف الأخطاء وإصلاحها (Troubleshooting): حلول للمشاكل الشائعة.
• الشكر والتقدير: قائمة بالأشخاص أو الجهات التي ساهمت في المشروع.
• سجل التغييرات (Changelog): موجه عادةً للمبرمجين لتتبع التحديثات.
• قسم الأخبار: موجه للمستخدمين النهائيين لإطلاعهم على الجديد.

تاريخ ملف README

بدأ تقليد إدراج ملف README في منتصف السبعينيات. في نظام Unix، حيث كانت معظم أسماء الملفات تكتب بأحرف صغيرة، تم استخدام الأحرف الكبيرة لاسم README لكي يبرز ويظهر في بداية القوائم المرتبة أبجدياً حسب نظام ASCII.

كما قامت أنظمة Macintosh المبكرة بتثبيت ملف "Read Me" على قرص التشغيل، وأصبح من الشائع إرفاق هذه الملفات مع البرمجيات الخارجية. وقد لعبت البرمجيات الحرة ومفتوحة المصدر دوراً كبيراً في تعزيز هذا التقليد، حيث تشجع معايير ترميز GNU على تضمين ملف README لتقديم نظرة عامة على الحزمة البرمجية.

README في عصر الويب و GitHub

مع ظهور الويب كمنصة أساسية لتوزيع البرمجيات، انتقلت بعض المعلومات من ملف README إلى مواقع إلكترونية أو صفحات ويكي (Wiki). ومع ذلك، يظل ملف README حيوياً، خاصة مع منصة GitHub التي تشجع بقوة على إنشائه؛ فإذا وجد الملف في المجلد الرئيسي للمستودع، يتم عرضه تلقائياً في الصفحة الرئيسية للمشروع. ويدعم GitHub تنسيقات متعددة، وخاصة README.md الذي يتم معالجته بتنسيق Markdown الخاص بـ GitHub.