مولد README.md

ساخت فایل README.md بدون شروع از یک فایل خالی

یک README خوب می‌تواند تفاوت بین ترغیب کسی به امتحان‌کردن پروژه‌تان و منصرف‌شدن او باشد. این مولد شما را از بخش‌هایی که هر README کامل به آن‌ها نیاز دارد عبور می‌دهد — عنوان، بج‌ها، قابلیت‌ها، مراحل نصب، نمونهٔ استفاده و مجوز — و هم‌زمان با تایپ شما، همه را به Markdown مرتب تبدیل می‌کند. همچنین پیش‌نمایش زندهٔ رندرشده‌ای ارائه می‌دهد تا پیش از commit، دقیقاً ببینید در GitHub چگونه نمایش داده خواهد شد.

نحوه استفاده

• نام پروژه، شعار و یک توضیح کوتاه را وارد کنید — این موارد به سربرگ و بخش درباره تبدیل می‌شوند.
• نشان‌های مجوز، نسخه، وضعیت build و «پول‌ریکوئست‌ها پذیرفته می‌شوند» را فعال کنید؛ این نشان‌ها به‌صورت Markdown نشان‌های shields.io تولید می‌شوند و به مخزن شما اشاره می‌کنند.
• بولت‌های قابلیت‌ها، یک دستور نصب و یک قطعه کد استفاده را اضافه کنید — هرکدام به‌طور خودکار با قالب‌بندی درست Markdown آماده می‌شوند.
• برای دیدن نسخه رندرشده، به «نمایش پیش‌نمایش» بروید؛ سپس Markdown را کپی کنید یا مستقیماً به‌عنوان README.md دانلود کنید.

موارد استفاده در دنیای واقعی

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

سؤالات متداول

این تصاویر نشان چیستند و به کجا اشاره می‌کنند؟

این نشان‌ها از طریق shields.io تولید می‌شوند؛ سرویس استانداردی که بیشتر READMEهای گیت‌هاب برای نشان‌ها استفاده می‌کنند — در Markdown فقط به یک URL تصویر ارجاع داده می‌شود، بنابراین به‌محض چسباندن آن در مخزن، کار می‌کند.

آیا می‌توانم بخش‌هایی را که نیاز ندارم نادیده بگیرم؟

بله — اگر فیلدی را خالی بگذارید، مثلاً مشارکت یا URL اسکرین‌شات، آن بخش به‌طور کامل از فایل تولیدشده حذف می‌شود.

آیا فهرست مطالب به‌صورت خودکار به‌روزرسانی می‌شود؟

بله، فقط بخش‌هایی را فهرست می‌کند که واقعاً محتوا دارند و پیوندها با لنگرهای بخشی مطابقت دارند که گیت‌هاب به‌طور خودکار از عنوان‌های شما تولید می‌کند.

کدام مجوز را باید انتخاب کنم؟

MIT رایج‌ترین انتخاب برای پروژه‌های متن‌باز است، چون کوتاه و کم‌محدودیت است. Apache 2.0 حمایت صریح از اختراع‌ها را اضافه می‌کند و GPL v3 الزام می‌کند آثار مشتق‌شده متن‌باز باقی بمانند — گزینه‌ای را انتخاب کنید که با نحوهٔ استفادهٔ دیگران از کدتان مطابقت دارد.

آیا این README با هوش مصنوعی تولید شده است؟

خیر — این ابزار بر اساس چیزهایی که در هر فیلد وارد می‌کنید، یک مونتاژگر ساده Markdown است. هیچ چیزی به جایی ارسال نمی‌شود؛ همه‌چیز در مرورگر شما انجام می‌شود.