مولّد README
املأ المعلومات الأساسية لمشروعك: تولّد الأداة ملف README.md منظمًا (العنوان، والوصف، والتثبيت، والاستخدام، والترخيص) جاهزًا للنسخ أو التنزيل.
كيف يعمل
أدخل اسم المشروع (الحقل الإلزامي الوحيد)، ووصفًا، وأمر التثبيت، ومثالًا للاستخدام، والترخيص. تجمع الأداة هذه المعلومات في مستند Markdown منظم يضم عنوانًا وجدول محتويات وقسمي «التثبيت» و«الاستخدام» مع كتل شيفرة، وقسم «الترخيص». وتتبع النتيجة بنية قريبة مما توصي به معظم أدلة المساهمة على GitHub.
هل يمكنني تعديل README بعد توليده؟
نعم، النص المولَّد نقطة انطلاق قابلة للتحرير مثل أي ملف Markdown: بعد نسخ الملف أو تنزيله، أضف أقسامًا (المساهمة، والاختبارات، ولقطات الشاشة) مباشرة في محررك المعتاد.
هل تعمل شارة الترخيص مع أي ترخيص؟
تُولَّد الشارة عبر خدمة shields.io باسم الترخيص كما أدخلته تمامًا؛ وتظهر بشكل صحيح للتراخيص الشائعة (MIT وApache-2.0 وGPL-3.0...). وفي حالة ترخيص مخصص، تظل الشارة تعمل لكنها أقل توحيدًا من الناحية البصرية.
تبقى جميع المعلومات المدخلة في متصفحك: لا يُرسَل شيء إلى خادم لتوليد هذا الملف README.