مولد README

استفاده تجاری ص ۳۸۰. بدون نشان آبی نیازی به ثبت نام نیست
مدل:
+ GPT-5, Claude, Gemini
پروژه خود را توصیف کنید (یا package.json / pyproject.toml / Cargo.toml را کپی کنید) و یک README.md تمیز را دریافت کنید — عنوان، shields، نصب، شروع سریع، ویژگی‌ها، مشارکت، مجوز. نوع پروژه، طول و رنگ را انتخاب کنید.
شامل:
پروژه‌ات رو توضيح بده
README.md

        
گزینه‌های پیشرفته
نتیجه
. رمزها کم ميشه گرفتن نشانه‌های بیشتر
نتيجه بهتري ميخواي؟ مدلهای پریمیوم (GPT-5, Claude, Gemini) کیفیت بالاتری را ارائه می‌دهند. نمایش نقشه

❤️ دوست Free.ai رو به دوستانت بگو

ثبت نام کنید تا لینک پیشنهادی دریافت کنید و 30 توکن برای هر دوست بدست آورید.

بيشتر ميخواي؟ ثبت نام مجاني براي 30K توکن/روز + 10K بونوس
ثبت نام

در حال پردازش درخواست شما...

تولید پرونده README پروژه با هوش مصنوعی آزاد. مستندات حرفه‌ای در چند ثانیه.

چطور استفاده کنم مولد README

1
وارد کردن ورودی

متن را تایپ کنید ، یک پرونده را بارگذاری کنید ، یا آنچه را که می‌خواهید توصیف کنید. حساب نیازی نیست.

2
ایجاد را بزنید

هوش مصنوعی ما درخواست شما را در چند ثانیه با استفاده از بهترین مدل‌های منبع باز پردازش می‌کند.

3
بارگیری و اشتراک

دانلود، کپی یا اشتراک‌گذاری نتایج خود. برای استفاده شخصی و تجاری رایگان است.

استفاده از این ابزار از طریق API

این ابزار را از کد خودتان خودکار کنید. نقطه پایانی REST سازگار با OpenAI، گواهی‌نامه حامل گواهی‌نامه، نیازی به SDK اضافی نیست. هزینه گواهی‌نامه با رابط وب مطابقت دارد.

curl -X POST https://api.free.ai/v1/chat/ \
  -H "Authorization: Bearer sk-free-..." \
  -H "Content-Type: application/json" \
  -d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'

مولد README — FAQ

پروژه خود را در ۲-۳ جمله شرح دهید (یا package.json / pyproject.toml / Cargo.toml را کپی کنید) و یک README.md مرتب شده را دریافت کنید — عنوان، نشانه‌های محافظ، جدول مطالب، نصب، شروع سریع، ویژگی‌ها، استفاده، بخش‌های اختیاری مشارکت / مجوز / FAQ. نوع پروژه را انتخاب کنید (کتابخانه / CLI / webapp / API / mobile / plugin / dataset / paper / template)، طول (حداقل → جامع) و طنینی (حرفه‌ای / دوستانه / فنی / بازاریابی / دانشگاهی).

readme-so و makeareadme.com قالب‌های پر کردن فرم هستند — شما به صورت دستی جعبه را علامت می‌زنید و بخش‌های موجود را دریافت می‌کنید. Free.ai تولیدکننده است — آن کپی خاصی برای پروژه شما می‌نویسد، دستورات نصب معقول / شکل API / رنگ را از توصیف شما استنباط می‌کند. Copilot ($10/mo) یک IDE خطی است و متن README را پاراگراف به پاراگراف تولید می‌کند؛ Free.ai تمام پرونده را در یک شلیک تولید می‌کند. برای ساختار خالص از readme-so استفاده کنید؛ Free.ai زمانی که شما یک کپی واقعی می‌خواهید.

هشدار سیستم به‌طور صریح اختراع ویژگی‌ها را ممنوع می‌کند. اگر توصیف مبهم باشد ، مدل جایگزین‌های « TODO » را وارد می‌کند. همیشه README تولید شده را بخوانید و TODOها را قبل از انتشار حذف کنید (یا با محتوای واقعی جایگزین کنید) — خروجی را به عنوان یک پیش‌نویس اول تمیز شده ، نه یک پرونده آماده برای ارسال در نظر بگیرید.

بله هنگامی که علامت زده شود — یک ردیف از ۳-۶ سپر (ساخت، نسخه، مجوز، دانلود، پوشش) با استفاده از نشانی‌های وب جایگزین که شما به پشتیبان خود سفارشی می‌کنید. مدل پیش‌فرض‌های منطقی بر اساس نوع پروژه را انتخاب می‌کند (کتابخانه نسخه npm یا نسخه pypi را دریافت می‌کند؛ CLI تعداد نصب را دریافت می‌کند؛ برنامه وب زمان اجرای را دریافت می‌کند).

حداقل (۱۰ خط) برای ابزارهای داخلی که هیچ‌کس کشف نخواهد کرد. استاندارد (~۸۰ خط) برای بیشتر پروژه‌های متن‌باز — به نقطهٔ دلخواه قابل یافتن بدون دیوارهای متن می‌رسد. جزئی (~۲۰۰ خط) برای پروژه‌هایی که به‌طور فعال بازاریابی می‌کنید. جامع (به سبک مستندات، ۳۰۰+ خط) هنگامی که README سایت مستندات اصلی شماست.

بله — صدای « بازاریابی » را انتخاب کنید. یک عنوان قوی، متنی با هدف سود، جایگزین‌های ثابت اجتماعی، CTAهای قوی تر دریافت می‌کنید. بخش‌ها دقیق باقی می‌مانند (هیچ ویژگی اختراع نشده) اما نثر به سبک گام است. برای بازیابی‌های آغاز SaaS، پروژه‌های پورتفولیو، انتشارات به سبک شکار محصول خوب است.

بله — صدای » آکادمیک « را انتخاب کنید. README شامل بخش » استناد « با قالب BibTeX و خط درخواست- اگر- استفاده شود ، به علاوه روشها و دامنههای تکرارپذیری است. برای بازیابی مقالات تحقیق و انتشار مدل / مجموعه داده‌ها خوب است.

بله — صفحه نتایج دارای دکمه‌های تغییر حالت Markdown/Preview است. Preview سمت کارگزار را با زیرمجموعه‌ای با طعم GitHub (عنوان‌ها، فشرده/مائل، بلوک‌های کد، کد در خط، فهرست‌ها، پیوندها) نمایش می‌دهد. به اندازهٔ خود GitHub زیبا نیست — همیشه یک آزمایش نهایی را با فشار دادن به یک مخزن انجام دهید.

مولد پیش‌فرض یک README تک پروژه را فرض می‌کند. برای یک README ریشه monorepo، repo را به عنوان یک monorepo در ورودی خود توصیف کنید ("contains 3 packages: foo, bar, baz") — مدل یک جدول بسته‌ها را اضافه می‌کند و دستورالعمل‌های نصب را رد می‌کند (چون نصب بر اساس بسته است). برای README بر اساس بسته، ابزار را یک بار بر اساس بسته اجرا کنید.

Qwen 3 Coder (مجان، پیش‌فرض) ۹۵٪ README را به خوبی مدیریت می‌کند. Qwen 2.5 7B کمی سریعتر است اما در زمینه بازاریابی کمتر تمیز است. Premium Claude Sonnet 4 به طور قابل توجهی در زمینه کپی بازاریابی و READMEهای کامل بهتر است - ارزش توکن‌های پرداخت شده برای پشتیبان صفحه مقصد شما را دارد.

The description is sent to the model, processed, and discarded. Not stored, not used for training. For maximum privacy pick Qwen 3 Coder — self-hosted on Free.ai's GPUs.

بله — POST به /v1/chat/ با دستور README سیستم (نوع + طول + صدا + پرچم‌های بخش) و شرح پروژه به عنوان پیام کاربر. مفید برای خودکارسازی تولید README در طول داربست پروژه. /api/ را ببینید.

براي 30000 تا توکن مجاني ثبت نام کن

ایجاد حساب

کارت اعتباري لازم نيست

اين ابزار رو چطور رتبه بندي ميکني؟

5.0/5 from 1 rating

دوست Free.ai رو به دوستانت بگو