مولّد README.md

Q: هل ينشئ ملف LICENSE أيضًا؟

لا. يضيف قسم ترخيص يرتبط بـ `LICENSE`؛ أضف نص الترخيص نفسه إلى مستودعك (يمكن لـ GitHub إنشاؤه لك).

املأ نموذجًا قصيرًا واحصل على README.md نظيف لـ GitHub مع شارات وأقسام التثبيت والاستخدام والميزات والمساهمة والترخيص ومعاينة Markdown مباشرة.

اسم المشروع

مستودع GitHub

owner/repo، يُستخدم للشارات وأمر git clone.

شعار من سطر واحد

الوصف

الميزات

ميزة واحدة في كل سطر.

أمر التثبيت

مثال الاستخدام

لغة كود المثال

الترخيص

المؤلف

إضافة شارات shields.io (تتطلب مستودعًا)جدول المحتوياتقسم المساهمة

README.md

# my-project

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

```bash
npm install
```

## Usage

```bash
npm start
```

## Contributing

Contributions are welcome! Please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/my-feature`)
3. Commit your changes (`git commit -m "Add my feature"`)
4. Push the branch (`git push origin feature/my-feature`)
5. Open a pull request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

تُكتب عناوين الأقسام بالإنجليزية كما هو معتاد في ملفات README مفتوحة المصدر. يبقى نصك كما كتبته.

أدوات ذات صلة

عرض الكل

مولّد الأرقام العشوائية مولّد Lorem Ipsum مولّد رمز QR مولّد UUID مولّد تعبير Cron مدقّق المجموع الاختباري للملفات مولّد مفاتيح API مولّد الرموز العشوائية

ما هو مولّد README؟

ملف README هو أول ملف يقرؤه الناس في المستودع. تحوّل هذه الأداة بضعة حقول — اسم المشروع والوصف والميزات وأوامر التثبيت والاستخدام والترخيص والمؤلف — إلى ملف README.md حسن البنية مع شارات shields.io اختيارية وجدول محتويات ودليل مساهمة. ويمكنك التبديل بين مصدر Markdown ومعاينة معروضة.

كيفية استخدام مولّد README

أدخل اسم المشروع، وإن كان على GitHub فأدخل مستودع GitHub بصيغة owner/repo.
أضف شعار من سطر واحد والوصف والميزات (واحدة في كل سطر) وأمر التثبيت ومثال الاستخدام.
اختر الترخيص وأضف المؤلف، وبدّل الشارات وجدول المحتويات وقسم المساهمة.
راجع معاينة، ثم انسخ README.md أو نزّله.

مثال

الإدخال

Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing

الإخراج

# tiny-cache

> A 1 KB LRU cache

## Installation

```bash
git clone https://github.com/acme/tiny-cache.git
cd tiny-cache
npm install
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

متى تستخدم مولّد README

استخدمه لبدء README لمكتبة جديدة أو أداة CLI أو مشروع جانبي أو مستودع داخلي في دقيقة، ثم حسّن النص يدويًا. ينتج هيكلًا معقولًا وليس توثيقًا: ما زلت بحاجة إلى شرح الإعدادات وتفاصيل API وأمثلة خاصة بمشروعك.

كيف يعمل مولّد README

يُجمَّع النموذج في Markdown بنكهة GitHub: عنوان H1 بالاسم، وشارات اختيارية (الترخيص والنجوم والمشكلات من img.shields.io، مرتبطة بالمستودع)، وشعار في اقتباس، ثم أقسام الميزات والتثبيت (مع كتلة git clone + cd عند تحديد مستودع) والاستخدام (كتلة كود بلغة تختارها) والمساهمة والترخيص والمؤلف. وتتبع روابط جدول المحتويات قواعد مراسي العناوين في GitHub. وتُعرض المعاينة بـ marked وتُعقَّم بـ DOMPurify.