چطوری README جذاب بنویسیم

برای شما

چیه README؟

درواقع یه فایل متنی که پروژتونو توضیح میده.شامل اطلاعاتی درباره کلیات پروژه و کارکرد پروژه میشه.

چرا باید پروژه README داشته باشه؟

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

چطوری بسازیمش؟

ازون جایی که README میتونه توی هر فرمتی نوشته بشه اما رایج ترین فرمتش Markdown است . اینکه Markdown چیه و چطوری میشه نوشتش میتونید به لینکی که گذاشتم سر بزنید.نترسید خیلی اسونه و دونستنش نیازتون میشه مخصوصا اگه علاقه مند به مشارکت توی پروژه های اپن سوروس هستید.برای ساختنش میتونید از هر تکست ادیتوری استفاده کنید.کلی پلاگینم برای Atom, Emacs,Sublime Text, Vim, Visual Studio Code داره که باهاشون هم میتونید فایل ریدمی هم ببنید و هم ادیت کنید.

رندر نشده

https://gist.github.com/gholamiayub/ee10fb32ef5e393faf2cc09399d2fcd5

رندر شده

https://gist.github.com/gholamiayub/162fae16cbfdd300a3d0f2d19b21e5aa

نکته هایی برای یه README جذاب

ازون جایی که پروژه ها با هم متفاوت هستند باید در نظر داشته باشید کدوم بخش هارو حتما توی README داشته باشید.بخشهایی که توی الگوهایی بالا گذاشتم توی اکثر پروژه ها نیازه که فایلی ریدمی تون داشته باشه.ازون جایی که توضیحات بعضی از پروژه ها میتونه خیلی طولانی باشه (گرچه هرچی توضیحات راجع به پروٰژه بیشتر باشه بهتره)بهتره برای پروژه هایی که مستندات زیادی دارن از ابزارهایی دیگه استفاده بشه که مخصوص مستندات پروژه های بزرگ gitbook ,readthedocs هستن .

نام

استفاده از نامی که بتونه پروژه رو توصیف کنه.

توضیحات

توضیحات پروژه میتونه شامل اینکه کارکردش چیه چرا این پروژه ساخته شده به نظر خودم هرچه این بخش مختصرو مفید باشه بهتره.

طریقه نصب

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

طریقه استفاده

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

لایسنس

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

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

امیدوارم چیزایی که گفتم کمکتون کرده باشه اگه پیشنهادی هم دارید میتونید پایین کامنت کنید تا به متن اضافه کنم

نویسنده مطلب: ایوب غلامی

منبع مطلب

به فکر سرمایه‌گذاری هستی؟

با هر سطحی از دانش در سریع‌ترین زمان با آموزش گام به گام، سرمایه گذاری را تجربه کن. همین الان میتونی با لینک زیر ثبت نام کنی و ۱۰ درصد تخفیف در کارمزد معاملاتی داشته باشی

ثبت نام و دریافت جایزه
ممکن است شما بپسندید
نظر شما درباره این مطلب

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