مولد ملف README لـ GitHub
أنشئ ملف README.md احترافيا لمشروعك على GitHub: شارات ونبذة وميزات والتقنيات المستخدمة والتثبيت والاستخدام ومتغيرات البيئة وخارطة الطريق والمساهمة والترخيص والمؤلف.
جارٍ تحميل مولد README لـ GitHub…
ملفاتك لا تغادر جهازك أبدًا
طريقة استخدام مولد README لـ GitHub
- 1
افتح مولد README لـ GitHub في هذه الصفحة. تُحمَّل مباشرة في متصفحك.
- 2
أضف ملفك أو نصك أو القيم، واضبط الإعدادات.
- 3
انسخ النتيجة أو نزّلها. لا يُرفع أي شيء ولا يُخزَّن.
عن هذه الأداة
ملف README هو الواجهة الأمامية لكل مستودع: أول ما يقرؤه الزوار ومسؤولو التوظيف والمساهمون. ينشئ مولد README لـ GitHub هذا ملف README.md كاملا ومنظما من نموذج قصير. املأ تفاصيل مشروعك، وفعّل الأقسام أو أوقفها، واختر التقنيات المستخدمة، ثم انسخ Markdown أو نزّل الملف. تُحفظ مسودتك في المتصفح أثناء العمل.
طريقة إنشاء README
- أدخل اسم المشروع وشعاره ووصفه.
- أضف مستودع GitHub (user/repo) لإنشاء الشارات، ورابط العرض التجريبي إن وجد.
- اختر الأقسام التي تريدها والتقنيات في مشروعك.
- اختر ترخيصا: MIT أو Apache 2.0 أو GPL 3.0 أو BSD 3-Clause أو MPL 2.0 أو Unlicense، وأضف المؤلف.
- راجع المعاينة، ثم انسخ Markdown أو نزّل README.md.
الأقسام المتاحة
- شارات من shields.io: النجوم والترخيص وغيرها.
- نبذة وميزات: ماذا يفعل المشروع ولماذا.
- التقنيات المستخدمة: اللغات وأطر العمل.
- التثبيت والاستخدام مع كتل كود.
- متغيرات البيئة اللازمة لتشغيله.
- خارطة الطريق وإرشادات المساهمة والترخيص والمؤلف.
ما الذي يجعل README جيدا
- قل ما يفعله المشروع في جملة واحدة في الأعلى تماما.
- اعرضه: لقطة شاشة أو GIF في الأعلى تشرح أكثر من فقرات كاملة.
- اجعل الإعداد قابلا للنسخ واللصق: أوامر دقيقة بالترتيب تعمل على جهاز جديد.
- حدّثه عندما تتغير الأوامر أو الخيارات.
عدّل النتيجة أكثر في محرر Markdown، وأضف جداول باستخدام مولد جداول Markdown، وراجع الصيغة في دليل Markdown المختصر.
الأسئلة الشائعة
ماذا يجب أن يتضمن ملف README؟
ما يفعله المشروع، وطريقة تثبيته واستخدامه، والتقنيات المستخدمة، وطريقة المساهمة، والترخيص. الشارات ولقطة الشاشة تساعد الزوار على الفهم بسرعة.
أين أضع ملف README؟
في جذر المستودع باسم README.md. يعرضه GitHub تلقائيا في صفحة المستودع.
هل يمكنني إضافة شارات؟
نعم. أدخل مستودعك بصيغة user/repo فيضيف المولد شارات shields.io الخاصة به.
ما التراخيص التي يمكنني اختيارها؟
MIT وApache 2.0 وGPL 3.0 وBSD 3-Clause وMPL 2.0 وUnlicense. أضف ملف LICENSE الكامل إلى مستودعك أيضا.
هل تُحفظ مسودتي؟
نعم، في التخزين المحلي لمتصفحك، فتبقى موجودة عند عودتك على الجهاز نفسه.
هل يمكنني إنشاء README للملف الشخصي؟
نعم. أنشئ مستودعا يحمل اسم المستخدم الخاص بك تماما واستخدم README للتعريف بنفسك؛ يعرضه GitHub في ملفك الشخصي.