קובץ README שנקרא עד הסוף

README הוא לא תיעוד. הוא המבחן הראשון של הפרויקט: אם מישהו לא מצליח להריץ אותו בדקה, הוא עובר לפרויקט הבא.

הסדר שהקורא עובר בפועל

1. שורה ראשונה: מה זה.
2. איך מריצים.
3. מה צריך להיות מותקן.
4. איפה הקונפיגורציה.
5. איך בודקים שזה עובד.
6. כל השאר.

כל דבר אחר לפני הסעיפים האלה לא ייקרא.

התבנית שעובדת

# שם הפרויקט

משפט אחד: מה זה עושה ולמי.

## הרצה

    npm install
    cp .env.example .env
    npm run dev

נפתח על http://localhost:3000

## דרישות

Node 22+, PostgreSQL 16

## קונפיגורציה

| משתנה | מה זה | חובה |
|---|---|---|
| DATABASE_URL | חיבור לבסיס נתונים | כן |
| PORT | פורט האזנה | לא (3000) |

## בדיקות

    npm test

## מבנה הפרויקט

    src/app        נתיבים
    src/lib        לוגיקה משותפת
    content        תוכן Markdown

הכללים

• פקודות בתור אחד, מוכן להעתק־הדבק. לא "התקינו את התלויות" — npm install.
• הצג את הפלט הרצוי. "נפתח על localhost:3000" חוסך עשר דקות ניחושים.
• טבלת משתני סביבה. זו הסעיף הכי מדולג והכי נדרש.
• אל תסביר את הארכיטקטורה בסעיף 1. מי שקורא README לראשונה רוצה להריץ, לא להבין.
• עדכן כשמשהו משתנה. README לא מעודכן גרוע מ-README חסר, כי הוא מטעה בביטחון.

מה שמוסיפים רק אם באמת יש

תמונה, לוגו, תג CI, רישיון. תג CI ירוק הוא אות אמין; תג שבור גרוע מהיעדרו.