فایل README

فایل README چیست؟

فایل README فایلی است که در مورد سایر فایل ها یا نرم افزاری که همراه آن توزیع می‌شود اطلاعاتی را ارائه می‌دهد. نام این فایل از عبارت Read me (به معنای مرا بخوان) گرفته شده است و اغلب داخل دایرکتوری اصلی (یا ریشه) محصول قرار می‌گیرد.

نام این فایل ها اغلب با حروف بزرگ نوشته می‌شود تا توجه کاربر را بیشتر از فایل های عادی موجود در دایرکتوری به خود جلب کند. این فایل ها با نام‌های مشابهی مانند README, README.txt, README.md یا Read Me مشاهده می‌شوند و معمولا حاوی متن ساده هستند.

وجود این نوع فایل‌ها به کاربر کمک می‌کند راحت‌تر با چگونگی نصب یا استفاده از محصول، ارتباط با سازندگان و … آشنا شود. از همینرو معمولا به کاربران پیشنهاد می‌شود پیش از انجام هر کاری، محتویات این فایل را مطالعه کنند و مطابق دستورالعمل‌های موجود در آن عمل کنند.

بد نیست بدانید سرویس میزبانی توسعه نرم افزار GitHub نیز به سازندگان مخزن ها توصیه می‌کند یک فایل README در دایرکتوری اصلی مخزن خود قرار دهند. محتویات این فایل (در صورت وجود) به صورت خودکار روی صفحه اصلی مخزن نمایش داده می‌شود. این فایل ها معمولا حاوی توضیحاتی در مورد پروژه، دستورالعمل نصب و پیش‌نیازها، چگونگی استفاده و همچنین همکاری در تکمیل آنست.

فایل README
نمونه‌ای از یک فایل README و محتویات آن که توسط نرم افزار ویرایشگر متن Notepad باز شده است.

محتویات فایل های Read Me

فایل های Readme متناسب با نرم افزار یا محتویات دیگری که داخل دایرکتوری قرار دارد شامل مواردی مانند:

  • معرفی نرم افزار، عملکرد و ویژگی‌های آن
  • راهنمای نصب نرم افزار
  • پیش نیازهای نرم افزار
  • راهنمای پیکربندی نرم افزار
  • لیست محتویات دایرکتوری
  • توضیحاتی در مورد تغییرات نسخه جدید
  • مجوز استفاده و حق کپی رایت
  • اطلاعات مربوط به تولیدکننده یا سازنده نرم افزار و راه‌های ارتباطی
  • چگونگی همکاری در ساخت و تکمیل پروژه

و … می‌شود. البته امروزه بسیاری از سازندگان نرم افزارها صرفا به یک فایل Read me ساده قناعت می‌کنند یا به طور کلی چنین فایلی را در پکیج توزیع نرم افزار خود نمی‌گنجانند و در عوض کاربر را به صفحه محصول در یک سایت رسمی هدایت می‌کنند.

پیوندهای پیشنهادی تک دیک

لینک واژه در ویکی‌پدیا

امیرحسین شهسواری

عاشق دنیای رایانه و فناوری به خصوص برنامه نویسی هستم؛ یادگرفتن و البته یاد دادن چیزای جالبی که یاد گرفتم باعث خوشحالیم میشه و از اولویت‌های اصلی زندگیم به حساب میاد. از مدیریت و نوشتن در تک دیک هم واقعا لذت می‌برم :)

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد.