چطوری یه README خفن برای پروژه مون بنویسیم؟!

سلام! احتمالا تا حالا اسم فایل ریدمی رو شنیده باشید، معمولا (از اچ تی ام ال هم میشه استفاده کرد) فایل های رید می رو با زبان مارک داون می نویسن. این زبان نشانه گذاری، ساده شده ی HTML هستش، پس فکر کنم فقط با خواندن این پست و روش های نوشتن یک ریدمی خفن،‌ می تونید استاد مارک داون بشید‌ (:

یادگیری زبان مارک داون

اگر زبان مارک داون رو بلدید می تونید این بخش رو نادیده بگیرید، ولی خب پیشنهاد می کنم که این بخش رو بخوانید شاید یه سری نکات جدید یاد گرفتید (=

برای درست کردن عنوان می تونید از علامت # استفاده کنید:

# h1
## h2
### h1
#### h1
##### h1
###### h1

نتیجه:

برای نوشتن متن نیاز به هیچ علامت خاصی ندارید.

بولد و ایتالیک کردن:

**Bold Text**
*Italic Text*

نتیجه:

کشید خط:

---

نتیجه:

چک لیست:

- [x] Checked check list
- [ ] I want to do this 

نتیجه:

استفاده از کد در وسط متن:

You can use `npm i express` to install express.js library. 

در اینجا باید از علامت بک تیک استفاده کنید که معمولا در کیبور کنار عدد ۱ هستش.

نتیجه:

نوشتن کد در زبان های برنامه نویسی مختلف:

Javascript Code:
```javascript
console.log(&quotHello, World!&quot)
```

Python Code:
```python
print(&quotHello, World in Python!&quot)
```

بازم نیاز به علامت بک تیک هستش، فقط به جای یه دونه شش تا می زارید و در وسط اون کد هاتون رو قرار می دین. همین طور که در نمونه کد بالا می بینید باید اسم زبان برنامه نویسی تون جلو سه تا بک تیک اول بزارید.

نتیجه:

درست کردن لینک:

[DockDockGo](https://duckduckgo.com/)

نتیجه:

و در آخر تصویر:

![alt - Github](Link of your image)

نتیجه:

من تا اینجا این ها یاد می آد. اگر چیز جدیدی بلد هستید حتما در کامنت بگید.

خب؟ حالا چجوری یه ریدمی خفن بنویسیم؟!

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

حالا من می خوام این تجربه ای که حاصل چند ماه فعالیت بنده در گیت هاب هست رو به شما منتقل کنم (=

یه ریدمی خفن باید بخش های زیر رو داشته باشه:

• بَنر (پوستر، عکس و ...)
• درباره پروژه (دو خط الی سه خط)
• نوع لایسنس
• نشان (badge) - می گم این ها رو از کجا بیارید (:
• ویژگی ها
• لیست چیز هایی که می خواید در آینده اضافه کنید (ToDo)
• و ...

پیشنهاد می کنم ریدمی های این تیم رو بخوانید تا بیشتر با نوشتن ریدمی آشنا بشید:

نشان ها رو از کجا بیاریم؟

اول از همه اینجا رو ببینید:

خب، چوطور بود؟ (: برای استفاده از نشان می تونید از این سایت استفاده کنید. طرز کار هم از این قرار:

مثلا شما می خواید تعداد ایشو هایی که در مخزن تون هست رو نشون بدید، خب طبیعتا باید اول نشانه ای که مربوط به این موضوع هست رو انتخاب کنید که فکر کنم این باشه:

همین طور که مشاهده می کنید برای این کار باید اول نام کاربری و بعد از اون اسم مخزن تون رو بدید:

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

خب فکر کنم به آخر پست رسیدیم (:

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

حتما نظرات و اشتباه های من رو در کامنت ها بگید تا در سریع ترین وقت ممکن اصلاحش کنم.

یا علی! (=