قدمبهقدم
راهنمای نصب و README همیشه یک شکل دارند: پیشنیازها، نصب، طرز استفاده. این کلمهها تابلوهای راهنمای همان مسیرند.
اشاره به بالا و پایین صفحه
مستندات با سه کلمه به جاهای دیگر همان صفحه اشاره میکنند. the following قبل از اسم میآید و یعنی «چیزی که درست بعد از این آمده»: «Run the following command:». above و below معمولاً بعد از اسم میآیند: «the example above»، «the table below». شکل مجهولش هم رایج است: «as shown below» یعنی «همانطور که پایین نشان داده شده».
هشت کلمهی این درس
step (اِستِپ): قدم؛ مرحله
step در انگلیسی یعنی قدم و پله. در راهنماها هر کار به چند step شمارهدار تقسیم میشود: Step 1، Step 2 و همینطور تا آخر. قانون مهمش این است که ترتیب را نگه داری و هیچ قدمی را جا نیندازی؛ بیشتر خطاهای نصب از پریدن از روی یک قدم میآید.
Repeat the previous step for each file in the folder.
قدم قبلی را برای هر فایلِ پوشه تکرار کن.
following (فالوئینگ): زیر؛ آنچه در ادامه میآید
follow یعنی «دنبال آمدن» و following یعنی «چیزی که بلافاصله بعد میآید». «Run the following command» یعنی «دستور زیر را اجرا کن» و خود دستور درست در خط بعد است. الگو: «the following + اسم» و بعد از آن دو نقطه. گاهی هم تنها میآید: «Do the following:».
Run the following command in your terminal.
دستور زیر را در ترمینالت اجرا کن.
above (اَباو): بالا؛ بالاتر در همین صفحه
above یعنی «بالا، بالاتر». در مستندات به چیزی اشاره میکند که قبلتر در همین صفحه آمده است: «the example above» یعنی مثال بالا و «as mentioned above» یعنی همانطور که بالاتر گفته شد. برای عددها هم میآید: «version 3.8 and above» یعنی ۳٫۸ و بالاتر.
The code above prints the numbers from one to ten.
کد بالا عددهای یک تا ده را چاپ میکند.
below (بیلُو): پایین؛ پایینتر در همین صفحه
below یعنی «پایین، پایینتر» و برعکس above است. «See the table below» یعنی جدول پایین را ببین و «the options listed below» یعنی گزینههایی که پایینتر فهرست شدهاند. برای عددها هم میآید: «values below zero» یعنی مقدارهای کمتر از صفر.
The table below lists all available options.
جدول پایین همهی گزینههای موجود را فهرست میکند.
prerequisite (پریرِکوِزیت): پیشنیاز
pre یعنی «پیش» و requisite یعنی «لازم»: روی هم «پیشنیاز». بخش Prerequisites اول راهنماها میگوید قبل از شروع چه چیزهایی باید داشته باشی (مثلاً پایتون ۳٫۱۰ و گیت) یا چه چیزهایی باید بلد باشی. اگر این بخش را نخوانده رد کنی، وسط کار به خطاهای عجیب میخوری.
Python 3.10 is a prerequisite for this tutorial.
پایتون ۳٫۱۰ پیشنیاز این آموزش است.
requirement (ریکوایِرمِنت): نیازمندی؛ چیزِ لازم
require یعنی «لازم داشتن» و requirement یعنی «چیزی که لازم است». System requirements میگوید برنامه چه سیستمی میخواهد (چقدر حافظه، کدام سیستمعامل). در پایتون فایل requirements.txt فهرست بستههایی است که پروژه لازم دارد. در کار تیمی هم requirements یعنی خواستههای مشتری از نرمافزار.
Check the system requirements before you install the game.
قبل از نصب بازی، نیازمندیهای سیستم را نگاه کن.
usage (یوسِج): طرز استفاده؛ میزان مصرف
use یعنی «استفاده کردن» و usage یعنی «شیوهی استفاده». بخش Usage در README نشان میدهد ابزار را چطور صدا بزنی. برنامههای خط فرمان هم وقتی دستور را غلط مینویسی، یک خط usage چاپ میکنند تا شکل درستش را ببینی. معنی دومش «میزان مصرف» است: memory usage یعنی مصرف حافظه.
See the usage section for more examples.
برای مثالهای بیشتر، بخش «طرز استفاده» را ببین.
installation (اینستِلِیشِن): نصب
install یعنی نصب کردن و installation یعنی «نصب» بهعنوان اسم. تقریباً هر README بخشی به اسم Installation دارد که دستورهای نصب را میدهد. این بخش را دقیق و به ترتیب بخوان؛ معمولاً برای هر سیستمعامل دستور جدا دارد.
The installation takes only a few minutes.
نصب فقط چند دقیقه طول میکشد.
README یک ابزار
# weather-cli
## Prerequisites
Python 3.10 or later. See the requirements file for the full list of packages.
## Installation
Step 1: Download the project.
Step 2: Run the following command in the project folder:
pip install -r requirements.txt
## Usage
python weather.py Tehran
The command above prints the weather for today. The table below lists more options.
# weather-cli
## پیشنیازها
پایتون ۳٫۱۰ یا بالاتر. برای فهرست کامل بستهها، فایل requirements را ببین.
## نصب
قدم ۱: پروژه را دانلود کن.
قدم ۲: دستور زیر را در پوشهی پروژه اجرا کن:
pip install -r requirements.txt
## طرز استفاده
python weather.py Tehran
دستور بالا هوای امروز را چاپ میکند. جدول پایین گزینههای بیشتری را فهرست میکند.