مولّد READMEمعالجة محلية في المتصفح
ar

AppHelp

أنشئ ملف README للمشروع بسرعة

املأ تفاصيل المشروع والميزات والأوامر والترخيص، ثم انسخ ملف README بصيغة Markdown.

# AppHelp

أداة تعمل محليًا في المتصفح للمهام اليومية.

## الميزات

- تعمل محليًا
- لا رفع افتراضيًا
- نتائج سهلة النسخ

## التثبيت

```bash
pnpm install
```

## الاستخدام

```bash
pnpm dev
```

## الترخيص

MIT

مهام شائعة

  • مولّد README
  • قالب README بصيغة Markdown
  • توثيق المشاريع
  • تعليمات التثبيت والاستخدام

إجابة سريعة

أنشئ README بصيغة Markdown من اسم المشروع ووصفه وميزاته وأمر التثبيت وأمر الاستخدام والترخيص. تتحدث المعاينة أثناء الكتابة ويمكن نسخها إلى README.md. هذه استمارة قالب محلية وليست تحليلًا للمستودع بالذكاء الاصطناعي.

طريقة الاستخدام

  1. 1. صف المشروعاستبدل الاسم والوصف التجريبيين. ضع كل ميزة في سطر مستقل لإنشاء قائمة Markdown.
  2. 2. أضف الأوامر والترخيصأدخل أوامر اختبرتها في المشروع؛ تظهر ضمن كتل bash. يسجل حقل الترخيص الاسم الذي تكتبه.
  3. 3. انسخ إلى README.mdراجع مصدر Markdown وانسخه واحفظه في المستودع. افحص طريقة عرضه وأضف الأقسام التي يحتاجها المشروع.

أمثلة

الميزات تتحول إلى قائمة

الإدخال
معالجة محلية
نسخ النتيجة
الإخراج
- معالجة محلية
- نسخ النتيجة

أمر تثبيت ضمن كتلة شفرة

الإدخال
pnpm install
الإخراج
```bash
pnpm install
```

حالات استخدام شائعة

  • إعداد مسودة README لمستودع صغير
  • توحيد تعليمات التثبيت والاستخدام قبل مشاركة المشروع

حالات خاصة

  • لا تقرأ الأداة المستودع ولا تكتشف التبعيات أو تتحقق من الأوامر؛ أنت توفر جميع معلومات المشروع.
  • تعرض المعاينة مصدر Markdown وليس HTML معروضًا. الإخراج الحالي ينسخ النص؛ احفظ الملف بنفسك.
  • قد تترك الحقول الفارغة أقسامًا فارغة. اسم الترخيص ليس ملف ترخيص كاملًا؛ أضف ملفات المشروع اللازمة بنفسك.

الميزات

  • استمارة README منظمة
  • معاينة مباشرة لمصدر Markdown
  • أقسام التثبيت والاستخدام
  • نسخ README الناتج

الأسئلة الشائعة

هل يستخدم الذكاء الاصطناعي لإنشاء README؟
لا. يضع قيم الحقول في بنية Markdown ثابتة داخل المتصفح ولا يفحص محتويات المستودع.
كيف أنزّل README.md؟
استخدم نسخ، والصق الناتج في محرر نصوص واحفظه باسم README.md، ثم راجع عرضه في المستودع.