একটা README.md সাধারণত একটা project সম্পর্কে যে কেউ দেখা প্রথম — কখনো কখনো একমাত্র — জিনিস। GitHub স্বয়ংক্রিয়ভাবে এটাকে formatted টেক্সট হিসেবে render করে, Markdown ব্যবহার করে, platform জুড়ে সবখানে (issue, pull request, comment-এও) ব্যবহৃত একটা হালকা সিনট্যাক্স।
# Heading 1
## Heading 2
### Heading 3
**bold text**
*italic text*
- Bullet point
- Another one
1. Numbered item
2. Another one
[Link text](https://example.com)
`inline code`
```javascript
// syntax highlighting সহ একটা fenced code block
const x = 1
```
> A blockquote
| Column 1 | Column 2 |
|----------|----------|
| Cell | Cell || Section | উদ্দেশ্য |
|---|---|
| Project title আর এক-লাইনের description | পাঁচ সেকেন্ডে এটা কী |
| Installation / setup step | locally এটা চালানোর ঠিক command |
| Usage উদাহরণ | এটা কাজ করছে দেখানো একটা code snippet বা screenshot |
| একটা live demo link, থাকলে | আসলে এটা কাজ করছে দেখার সবচেয়ে দ্রুত উপায় |
| License | অন্যরা কোড ব্যবহার করতে পারে কিনা আর কীভাবে — আগের repository-creation lesson থেকে |
# Todo App
A simple todo list built with vanilla JavaScript.
## Setup
```bash
git clone https://github.com/username/todo-app.git
cd todo-app
open index.html
```
## Features
- Add and remove tasks
- Mark tasks complete
- Saves to localStorage
## License
MITএকটা README আসলে কার জন্য
একজন অপরিচিত যে project সম্পর্কে কিছু জানে না তার জন্য লেখা একটা README — নিজের জন্য একটা note না — সঠিক target। একজন নতুন visitor প্রথম কয়েক লাইনে project কী করে আর কীভাবে চালাতে হয় বলতে না পারলে, কোড যতই ভালো হোক না কেন README-এর কাজ দরকার।