محول مجاني

مولّد قالب README.md

أنشئ قوالب README.md احترافية لمشاريع GitHub الخاصة بك. خصّص الأقسام والشارات والتنسيق في ثوانٍ.

الإعدادات
تضمين الشارات
تضمين الأقسام
التقنيات المستخدمة
README.md المُنشأ
# my-project

> A short description of your project.

[![npm version](https://img.shields.io/npm/v/my-project.svg)](https://www.npmjs.com/package/my-project)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://img.shields.io/github/actions/workflow/status/username/repo/ci.yml)](https://github.com/username/repo/actions)

## Table of Contents

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

## Features

- Feature 1
- Feature 2
- Feature 3

## Installation

```bash
npm install my-project
```

Or using yarn:

```bash
yarn add my-project
```

## Usage

```javascript
const myProject = require('my-project');

// Example usage
// my-project.doSomething();
```

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct.

## License

MIT © [Author Name](https://github.com/username)

See [LICENSE](LICENSE) for more information.

---

Made with by [Author Name](https://github.com/username)

حول هذه الأداة

قم بإنشاء ملفات README.md احترافية لمستودعات GitHub الخاصة بك. املأ الأقسام الخاصة بوصف المشروع والتثبيت والاستخدام ومرجع واجهة برمجة التطبيقات (API) وإرشادات المساهمة والترخيص. تُنتج الأداة Markdown منظم جيدًا وفقًا لمعايير مجتمع GitHub وأفضل الممارسات للوثائق مفتوحة المصدر.

كيفية الاستخدام

  1. أدخل اسم مشروعك ووصفه والميزات الرئيسية.
  2. املأ تعليمات التثبيت وأمثلة الاستخدام.
  3. أضف أقسامًا اختيارية: مستندات API، وإرشادات المساهمة، والترخيص.
  4. انسخ Markdown الذي تم إنشاؤه واحفظه باسم README.md في مستودعك.

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

ما هي الأقسام التي يجب أن يحتوي عليها الملف التمهيدي الجيد؟
أساسي: اسم/وصف المشروع، التثبيت، أمثلة الاستخدام. موصى به: الميزات، مرجع واجهة برمجة التطبيقات (API)، إرشادات المساهمة، الترخيص، الشارات. اختياري: لقطات الشاشة، سجل التغيير، الأسئلة الشائعة، الإقرارات.
ما هو بناء جملة Markdown الذي يعمل على GitHub؟
يدعم GitHub Flavoured Markdown (GFM) جداول Markdown plus القياسية، وقوائم المهام (- [ ])، وكتل التعليمات البرمجية المميزة ببناء الجملة (```python)، وعناوين URL المرتبطة تلقائيًا، ويتوسطه خط (~~text~~)، والأكواد القصيرة للرموز التعبيرية (:rocket:).
كم من الوقت يجب أن يكون README؟
طويلة بما يكفي لمساعدة المستخدمين على البدء، وقصيرة بما يكفي لقراءتها. معظم ملفات README مفتوحة المصدر الناجحة هي 200-500 سطر. استخدم جدول محتويات للمستندات الأطول واربطه بمستندات منفصلة للحصول على أدلة تفصيلية.
هل يجب علي تضمين الشارات؟
توفر الشارات (حالة البناء، إصدار npm، الترخيص) مؤشرات سريعة لسلامة المشروع. إنها قياسية للحزم مفتوحة المصدر. استخدم Shields.io لتصميم شارة متسقة.