مقدمه

در دنیای برنامه‌نویسی، هر پروژه نرم‌افزاری نیاز دارد تا به‌روشی ساده و روشن معرفی شود؛ جایی که دیگران بتوانند هدف آن را بفهمند، نحوه‌ی استفاده از آن را یاد بگیرند و مسیر اجرای آن را دنبال کنند.اینجاست که باید بدانید README.md چیست.

این فایل اولین چیزی است که هر کسی هنگام باز کردن یک پروژه در گیت‌هاب یا سایر مخزن‌های کد مشاهده می‌کند و نقش یک راهنمای جامع را ایفا می‌نماید.

داشتن یک README خوب، نشان‌دهنده‌ی نظم، حرفه‌ای بودن و احترام به دیگر توسعه‌دهندگان و کاربران است.

حتی اگر پروژه‌ی شما کوچک باشد، یک README مرتب و قابل فهم می‌تواند باعث شود دیگران راحت‌تر از آن استفاده کنند یا در توسعه‌اش مشارکت داشته باشند.

در این مقاله در کداستور پرو، گام‌به‌گام یاد می‌گیریم که فایل README.md چیست، چرا اهمیت دارد، و چگونه می‌توان آن را به شکلی استاندارد و حرفه‌ای نوشت.

   فایل README.md چیست ؟

این اولین فایلی است که هر کسی باید هنگام کار یک پروژه یا شروع یک پروژه جدید بخواند ، این فایل مثل یک دفترچه ی راهنمای کوچک است که خلاصه ای از تمام اطلاعات مفید یک پروژه از جمله نحوه ی استفاده ، نحوه نصب ، هدف پروژه و تکنولوژی هایی  که در این پروژه استفاده شده است را بیان می کند .

شاید برای شما این سوال پیش بیاید که README ، یعنی مرا بخوان، با حروف بزرگ نوشته است ؟ و در پاسخ باید گفت که این کار برای جلب توجه بیشتر و نشان دادن مهم بودن این فایل است .

زبان این فایل ، زبان نشانه گذاری markdown  است .

   چرا باید از این فایل استفاده کنیم؟!

• این فایل اولین فایلی است که شخص از پروژه ی شما میبیند پس باید بتوانید پروژه ی خود را به طور کوتاه و خلاصه شرح دهید .
• برای کسانی که دانش برنامه نویسی ندارند این امکان را می دهد تا از نحوه ی کارکرد پروژه ی شما آگاه شوند .
• برای هر پروژه ای ، این فایل یکی از ملزومات است ، اگر پروژه خود را به عنوان نمونه کار میخواهید ارائه دهید ، داشتن این فایل ، نشان دهنده حرفه ای بودن شماست .
• یکی از مهم مستنداتی است که شما باید در پروژه ی خود درج کنید . (اگر در مورد مستندسازی میخواهید بیشتر بدانید ، اینجا کلیک کنید .)

   محتویات فایل README.md  چیست ؟!

• معرفی سایت یا پروژه و بررسی هدف آن
• اگر نیاز به نصب بود ، راهنمای نصب آن
• پیش نیاز های لازمه آن برای اجرا
• تکنولوژی هایی که در آن استفاده شده است .

   یک فایل README.md  خوب ، چه ویژگی هایی دارد :

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

• درج عنوان پروژه خود :

این نام پروژه است و قرار است تمام پروژه و هدف آن را در یک جمله خلاصه کند. در انتخاب آن دقت فرمایید ، چرا که قرار است کاری که انجام میدهد رابیان کند .

• توضیحات را بنویسید :

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

• نحوه نصب پروژه :

اگر این پروژه ، یک نرم افزار است و شما برای اجرای آن ، نیاز به نصب دارید ، بهتر است مراحل و گام های نصب را مشخص کنید و حتما اگر نرم افزار شما نیاز به پیش نیاز خاصی دارد ، حتما از قبل در فایل اشاره کنید .

• اعتبارات :

اگر به عنوان یک تیم یا سازمان خاصی  روی این پروژه کار کرده اید، هم تیمی ها و کسانی که در پروژه نقش داشتنددر فایل خود فهرست کنید.

همچنین باید لینک هایی به پروفایل های گیت هاب آن ها اضافه کنید.

همچنین، اگر آموزش‌هایی را برای ساخت آن پروژه خاص دنبال کرده‌اید ، لینک هایی به آن‌ها را نیز در اینجا قرار دهید.

این فقط راهی برای نشان دادن قدردانی شما و همچنین کمک به دیگران برای دریافت نسخه دست اول از پروژه است.

برای درک بهتر این موضوع میتوانید به readme فایل هایی که دیگران در گیت هاب گذاشته اند سری بزنید و فایل های آنها را مشاهده کنید . برای دریافت اطلاعات بیشتر  ، اینجا کلیک کنید .

   جمع بندی :

در این مقاله، به‌صورت ساده با مفهوم فایل README و نقش آن در معرفی پروژه‌ها آشنا شدیم.

فهمیدیم که این فایل راهنمای اصلی هر پروژه است و به دیگران کمک می‌کند هدف، ساختار و نحوه‌ی استفاده از آن را بهتر درک کنند.

همچنین اشاره شد که داشتن یک README منظم، اولین قدم برای ارائه‌ی حرفه‌ای یک پروژه محسوب می‌شود.

در پایان، از شما خواننده‌ی گرامی برای صرف زمان و مطالعه‌ی این مطلب صمیمانه سپاسگزارم و امیدوارم مطالعه‌ی آن برایتان مفید بوده باشد.