ReadMeCreator With LLM

ReadMe Creator باستخدام LLM

مرحبا بكم في ReadMe Creator! تعمل هذه الأداة على تبسيط عملية إنشاء ملفات ReadMe التفاعلية.

سمات

• قم بإنشاء قوالب ReadMe بسرعة.
• تخصيص القوالب مع مطالبات سهلة الاستخدام.
• إنشاء ملفات ReadMe التفاعلية والجذابة بصريًا.

ابدء

1. استنساخ هذا المستودع:

git clone https://github.com/ashishpatel26/readme-creator-with-LLM.git
cd readme-creator

2. تثبيت التبعيات المطلوبة:

pip install -r requirements.txt

3. قم بإعداد مفتاح Openai API عن طريق تصديره كمتغير للبيئة:

 export OPEN_AI_KEY=your_openai_key_here

الاستخدام

قم بتشغيل الأمر التالي لبدء تشغيل Creator ReadMe:

python src/readme_creator.py

اتبع المطالبات لتخصيص قالب ReadMe الخاص بك. ستقوم الأداة بإنشاء ملف readMe.md تفاعلي في دليل الجذر.

أمثلة

تحقق من examples/ الدليل لقوالب README مصممة مسبقًا وإخراجها المقابل.

المساهمة

نرحب بالمساهمات! لا تتردد في تقديم طلبات السحب.

رخصة

تم ترخيص هذا المشروع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا - راجع ملف الترخيص للحصول على التفاصيل.