README یعنی چه؟
تلفظ: رید می · نوع: اسم
معنی README: فایل معرفی پروژه؛ اولین چیزی که باید بخوانی
read me یعنی «من را بخوان». README فایلی است در ریشهی پروژه که خودش از تو میخواهد اول آن را بخوانی: این پروژه چیست، چطور نصب میشود، چطور اجرا میشود و چطور میشود در آن کمک کرد. اسمش را با حروف بزرگ مینویسند تا در فهرست فایلها به چشم بیاید. GitHub این فایل را خودکار در صفحهی اول مخزن نشان میدهد.
README در جمله
Read the README first; it explains how to install the project.
اول README را بخوان؛ توضیح میدهد پروژه چطور نصب میشود.
README در کد
# My Game
A small space game written in Python.
## Installation
pip install -r requirements.txtیک README ساده: اسم پروژه، یک جمله معرفی و روش نصب. پسوند .md یعنی با Markdown نوشته شده است.
کلمههای مرتبط
- documentation: مستندات؛ نوشتههای راهنمای یک ابزار
- installation: نصب
- introduction: مقدمه، معرفی
درس این کلمه
README یکی از هشت کلمهی درس «متنباز» در فاز 5: ابزار و گیت از دورهی انگلیسی برای برنامهنویسها است. بقیهی کلمههای این درس:
- open source: متنباز؛ نرمافزاری که کد منبعش را همه میتوانند ببینند
- license: مجوز؛ متنی که میگوید با این کد چه کارهایی مجاز است
- contributor: مشارکتکننده؛ کسی که در یک پروژه سهمی داشته است
- maintainer: نگهدارنده؛ مسئول اصلی یک پروژه
- changelog: فهرست تغییرهای هر نسخه
- issue tracker: سامانهی ثبت و پیگیری باگها و کارها
- star: ستاره؛ نشانهی پسندیدن یک مخزن در گیتهاب