Is this free README generator really free?

Yes. Every tool on freemarkdowntools.com is free forever.

Does it include badges?

Yes. Toggle 'Include badges' to add npm version, license, and build-status badges from shields.io.

What templates are available?

Minimal (title + description + license), Standard (adds features + usage), Library (adds API section), and Web App (adds Getting Started with repo clone).

Can I edit the generated Markdown?

Yes. The output is regular Markdown — paste it into any editor and customize further.

No. The tool runs 100% in your browser.

مولد README

أنشئ ملف README مثالي لـ GitHub في دقائق.

Template:

اسم المشروع الشعار الوصف اسم المؤلف اسم مستخدم GitHub أمر التثبيت Usage code example الرخصة

أقسام اختيارية تضمين الشارات تضمين المساهمة تضمين الاختبارات

README.md 764 حرف

![npm version](https://img.shields.io/npm/v/my-awesome-project)
![license](https://img.shields.io/badge/license-MIT-blue)
![build](https://img.shields.io/github/actions/workflow/status/username/my-awesome-project/ci.yml)

# My Awesome Project

> A short, memorable one-liner

A longer description of what this project does and who it's for.

## Features

- ✨ Feature one
- 🚀 Feature two
- 🔒 Feature three

## Installation

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

## Usage

```js
import { doThing } from "my-awesome-project";

const result = doThing({ foo: "bar" });
console.log(result);
```

## Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change, then submit a pull request.

## License

MIT © Your Name

ملخص — ماذا يفعل مولد README المجاني

ما هذه الأداة المجانية

مولّد README المجاني يبني ملف README.md مثالي لـ GitHub من نموذج قصير. اختر قالباً (Minimal أو Standard أو Library أو Web App)، واملأ اسم المشروع والوصف والمؤلف وأمر التثبيت وشيفرة الاستخدام — واحصل على README مصقول في ثوانٍ. الشارات والترخيص وقسم المساهمة وقسم الاختبارات كلها بتبديل واحد.

الخصوصية: هذه الأداة تعمل بالكامل في متصفحك. لا يتم رفع أو تسجيل أو تخزين نصك أبدًا. أغلق التبويب وسيختفي كل شيء. تحقق في DevTools → Network: لا يتم إرسال أي طلبات.

لماذا هي مجانية (وكيف نبقيها مجانية)

ملفات README الجيدة هي الفرق بين مشروع مفتوح المصدر يستخدمه الناس وآخر ينسونه. نريد لكل أداة مجانية وكل مكتبة مستقلة وكل مشروع جانبي أن يكون لديه README لائق. لهذا هو مجاني للأبد.

جدول الاستخدام

مرجع سريع

إدخال	إخراج	الحجم النموذجي	السرعة	يتطلب تسجيل دخول
Form fields	README.md (GitHub-ready)	Any project	Real-time	No

ميزات مولد README

إليك ما تفعله هذه الأداة المجانية بالتفصيل — كل ميزة مصممة لحل مشكلات حقيقية، تعمل بالكامل في متصفحك، ومجانية إلى الأبد.

4 قوالب مشروع لأنواع مختلفة

اختر القالب الذي يتطابق مع مشروعك: Minimal (عنوان + وصف + ترخيص، للمكتبات الصغيرة)، Standard (يضيف أقسام الميزات والاستخدام، لمشاريع المصدر المفتوح النموذجية)، Library (يضيف قسم API مع توقيعات الدوال، للمكتبات القابلة لإعادة الاستخدام)، أو Web App (يضيف قسم بدء العمل مع تعليمات استنساخ المستودع وخادم التطوير).

بمجرد حصولك على نص README، يمكنك عرضه كـ HTML بـ محوّل Markdown إلى HTML المجاني لمعاينة شكله على صفحة مشروعك.

شارات Shields.io المولّدة تلقائياً

فعّل تضمين الشارات لإضافة صف من شارات shields.io في أعلى README — إصدار npm والترخيص وحالة بناء GitHub Actions. تُولَّد الشارات من اسم مشروعك واسم مستخدم GitHub.

لجدول محتويات يربط بكل قسم من README، استخدم مولّد جدول محتويات Markdown المجاني على الإخراج الناتج.

منتقي ترخيص مع 6 خيارات مفتوحة المصدر

اختر من MIT أو Apache 2.0 أو GPL-3.0 أو BSD 3-Clause أو ISC أو Unlicense — أكثر 6 تراخيص مفتوحة المصدر شيوعاً. قسم الترخيص في README يُحدَّث فوراً.

إذا كان README لمشروعك يحتاج تضمين جداول (مقارنات ميزات، خيارات تكوين، متغيرات بيئة)، فإن مولّد جداول Markdown المجاني يبنيها بصرياً.

أقسام المساهمة والاختبارات الاختيارية

بدّل قسم المساهمة تشغيلاً أو إيقافاً لتضمين نص ترحيبي يدعو لطلبات السحب وتقارير المشاكل. بدّل قسم الاختبارات لتضمين تعليمات تشغيل مجموعة الاختبارات (الافتراضي npm test، قابل للتعديل بعد النسخ).

بعد التوليد، نظّف أي تناقضات بـ منسّق Markdown المجاني.

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

الخطوة 1 — اختر قالباً

اختر Minimal أو Standard أو Library أو Web App حسب نوع مشروعك.

الخطوة 2 — املأ النموذج

اسم المشروع، الشعار، الوصف، المؤلف، أمر التثبيت، شيفرة الاستخدام، الترخيص.

الخطوة 3 — بدّل الأقسام الاختيارية

أضف أو أزل الشارات والمساهمة أو أقسام الاختبارات.

من يمكنه استخدام هذه الأداة

Open source maintainers

Shipping a polished README for every library release — no more 'figure out how to use this' friction.

Indie developers

Ship side projects with professional READMEs that make them look like real products.

Students building portfolios

Every project on your GitHub profile needs a README. This takes 2 minutes.

Hackathon teams

Ship your hackathon project with a real README even when you're running on 3 hours of sleep.

Technical writers

Starting from a solid template and customizing instead of staring at a blank file.

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

هل مولّد README المجاني هذا مجاني فعلاً؟

نعم. كل أداة على freemarkdowntools.com مجانية للأبد.

هل يتضمن شارات؟

نعم. شارات shields.io لإصدار npm والترخيص وحالة البناء مُضمَّنة افتراضياً. أوقفها إذا لم تكن تريدها.

ما القوالب المتاحة؟

Minimal (عنوان + ترخيص)، Standard (يضيف ميزات + استخدام)، Library (يضيف قسم API)، Web App (يضيف بدء العمل مع استنساخ المستودع).

هل يمكنني تعديل Markdown الناتج؟

نعم. الإخراج هو Markdown عادي — انسخه والصقه وخصّصه أكثر في أي محرر.

هل تُخزَّن بياناتي؟

لا. الأداة تعمل 100% في متصفحك.