GitHubBeginner
README ও Markdown — প্রজেক্টের মুখ
ভালো README লিখা ও Markdown-এর মৌলিক — বাংলায়।
13টি অংশবাংলা ভাষায়
README কেন গুরুত্বপূর্ণ?
Repository-তে প্রথম যে জিনিস visitors দেখে তা-ই README। এটি সিদ্ধান্ত নেয় — মানুষ project ব্যবহার, contribute নাকি এড়িয়ে যাবে।
ভালো README-এর কাঠামো
- প্রজেক্টের নাম ও একটি লাইন — কী এটি
- Screenshot / demo — এক চোখে বোঝা যায়
- Installation — কীভাবে setup করবেন
- Usage — কীভাবে চলবে
- Features — bullets
- Tech stack — badge
- Contribution — কীভাবে সাহায্য করবেন
- License
Markdown-এর মৌলিক
উদাহরণ README.mdmarkdown
markdown
# Blog App
আধুনিক blog — Astro ও Tailwind CSS-এ নির্মিত।
## Features
- ডার্ক মোড
- RSS ফিড
- দ্রুত লোডিং
## ইনস্টলেশন
npm install
npm run dev
## License
MITদরকারি Markdown syntax
| Syntax | ফলাফল |
|---|---|
| # Heading | বড় শিরোনাম |
| bold | বোল্ড |
| link | হাইপারলিংক |
code | ইনলাইন কোড |
| - item | বুলেট লিস্ট |
| > quote | উদ্ধৃতি |
| | col | col | | টেবিল |
README-তে ছবি যোগ
Profile README
username-এর মতো নামে repository (যেমন anamolhasan) বানিয়ে সেখানে README লিখলে — আপনার GitHub profile-এর উপরে সেই text দেখা যাবে।
নিয়ম
README আগে নিজে পড়ুন — আপনি নিজে বোঝেন তো? জানা ব্যস্ততা নয়, সরল ভাষায় লিখুন।
শেষ প্যারায় নিজে practice করুন — কোড কপি করে নিজের এডিটরে চালিয়ে দেখুন।