جوړونکی README
سوداګريزه کارونه
380+ ماډلونه
هېڅ اوبه نښه
هېڅ ننوت اړين نه دی
:ډول
+ GPT-5, Claude, Gemini
خپل پروژه تشریح کړئ (یا د بسته کولو.json / pyproject.toml / Cargo.toml) او بیرته یو پالش شوی README.md ترلاسه کړئ - سرلیک، شیلډونه، نصب، ګړندی پیل، ځانګړتیاوې، مرسته، جواز. د خپل پروژې ډول، اوږدوالی او رنګ غوره کړئ.
ژور غوراوي
پایله
.ټېکېنونه کم دي
نور توکي اخيستل
❤️ Free.ai مینه؟ خپل ملګرو ته ووایاست!
سپړنه وکړئ د حوالې لینک ترلاسه کولو او د هر ملګري لپاره د 25,000 توکو ترلاسه کولو لپاره.
نور غواړﺉ؟
د 30K توکي / ورځ + 10K بونس لپاره وړیا نوم لیکنه وکړئ
د وړيا لپاره راجستر شئ
...ستاسو غوښتنه بهير کيږي
د وړیا AI سره د پروژې README فایلونه رامینځته کړئ. په ثانیو کې مسلکي اسناد.
څنګه کارول جوړونکی README
1
خپل ننوت وليکﺉ
ليکنه وليکﺉ، دوتنه رالېښﺉ، يا هغه څه وټاکﺉ چې غواړﺉ. هېڅ ګڼون نه اړين دی.
2
جوړولو ته کېکاږﺉ
زموږ AI ستاسو غوښتنه په ثانیو کې د غوره خلاص سرچینې ماډلونو په کارولو سره پروسس کوي.
3
رالېښل & ونډول
ډاونلوډ، کاپي، یا ستاسو د پایلو شریکول. د شخصي او سوداګریزو کارونې لپاره وړیا.
دا توکي په API کارول
د خپل کوډ څخه دا وسیله اتومات کړئ. د OpenAI-متوافق REST پای ټکی، د بارر-ټوکن اېټ، اضافي 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
ستاسو پروژه په 2-3 جملو کې تشریح کړئ (یا د بسته بندۍ.json / pyproject.toml / Cargo.toml) او بیرته یو پالش شوی README.md ترلاسه کړئ - سرلیک، د شیلډ بیګز، د مینځپانګې جدول، نصب، ګړندی پیل، ځانګړتیاوې، کارولو، اختیاري مرسته / جواز / FAQ برخې. د پروژې ډول غوره کړئ (کتابتون / CLI / webapp / API / ګرځنده / پلگ ان / ډیټا سیټ / کاغذ / ټیمپلیټ)، اوږدوالی (د لږترلږه → بشپړ) او ټون (پروفیسشنل / دوستانه / تخنیکي / بازار موندنه / اکاډمیک).
readme-so او makeareadme.com د فورمې ډکولو ټیمپلیټونه دي - تاسو په لاسي ډول بکسونه ټایپ کوئ او د سټاک برخې ترلاسه کوئ. Free.ai تولیدي دی - دا ستاسو د پروژې لپاره ځانګړی کاپي لیکي، د مناسب نصب کولو امرونه / API شکل / ستاسو د توضیحاتو څخه ټون استنباط کوي. کوپیلوټ ($ 10 / mo) د انلاین-IDE دی او د README متن پراګراف لخوا پراګراف تولیدوي لکه څنګه چې تاسو ډول؛ Free.ai په یوه شېبه کې ټوله فایل تولیدوي. د خالص جوړښت لپاره readme-so وکاروئ؛ Free.ai کله چې تاسو واقعیت کاپي غواړئ.
د سیسټم پروموشن په څرګنده توګه د ځانګړتیاوو اختراع منع کوي. که چېرې توضیحات مبهم وي، ماډل "TODO" ځایونه داخلوي. تل د تولید شوي README ولولئ او TODOs لرې کړئ (یا د ریښتیني محتوا سره ځای په ځای کړئ) د خپرولو دمخه - د محصول په توګه د لومړي پالش شوي مسوده، نه د کښتۍ چمتو فایل درملنه وکړئ.
هو کله چې چک شوی - د 3-6 شیلډونو یو قطار (بیا جوړ کړئ، نسخه، جواز، ډاونلوډونه، پوښښ) د ځای ځای URLs کارولو سره چې تاسو یې خپل repo ته دودیز کوئ. ماډل د پروژې ډول پراساس منطقي defaults غوره کوي (کتابتون د npm-version یا pypi-version ترلاسه کوي؛ CLI د نصب کولو شمیر ترلاسه کوي؛ ویب اپ د وخت ترلاسه کوي).
د داخلي وسایلو لپاره لږترلږه (10 کرښې) هیڅوک به ونه موندل شي. د ډیری خلاص سرچینې پروژو لپاره معیاري (~ 80 کرښې) - د متن دیوالونو پرته د موندلو خوندي ځای ته زیان رسوي. د پروژو لپاره تفصیلي (~ 200 کرښې) تاسو په فعاله توګه بازار ته ځي. بشپړ (د اسنادو سټایل، 300 + کرښې) کله چې README ستاسو لومړنی د اسنادو سایټ دی.
هو - د "مارکیټ" ټون غوره کړئ. تاسو یو قوي سرلیک ترلاسه کوئ، د ګټې رهبري کاپي، د ټولنیز ثبوت ځایونه، قوي CTAs. برخې دقیق پاتې کیږي (نه اختراع شوي ځانګړتیاوې) مګر نثر د پیچ ډول دی. د SaaS پیل کولو لپاره ښه، د پورټ فولیو پروژې، د محصول د شکار ډول خپرول.
هو - د "اکاډمیک" ټون غوره کړئ. د README کې د BibTeX ټیمپلیټ او د غوښتنې-که-کارولو کرښې سره د "کود" برخه شامله ده، او همدارنګه میتودونه او د بیا تولید ساحې. د څیړنې کاغذونو او ماډل / ډیټا سیټونو لپاره ښه.
هو - د پایلې پینل د مارکډون / مخکښ توګ بټونه لري. مخکښ د ګیټوب-نرم شوي فرعي برخې سره د پیرودونکي اړخ (سرلیکونه، bold / italic، کوډ بلاکونه، انلاین کوډ، لیستونه، لینکونه) سره راځي. د ګیټوب په څیر نه پالش کیږي - تل د ریپ ته د فشار ورکولو سره وروستي ازموینه وکړئ.
د تلپاتې تولید کونکی د یو واحد پروژې README اخلي. د یو monorepo ریښتیني README لپاره، د خپل انټرنیټ کې د مونورپو په توګه د ریپ تشریح کړئ ("د 3 بسته لري: فو، بار، بز") - ماډل د بسته جدول اضافه کوي او د نصب کولو لارښوونې پرې کوي (ځکه چې نصب کول د بسته په توګه دی). د هر بسته READMEs لپاره، وسیله یو ځل د بسته په توګه چلوئ.
Qwen 3 کوډر (خپل، تلواله) د READMEs 95٪ ښه اداره کوي. Qwen 3 30B په بازار موندنې کې ډیر پالش او متوازن دی. د پریمیم Claude Sonnet 4 په بازار موندنې کې د ټن کاپي او بشپړ اوږدوالي READMEs کې په پام کې نیولو سره ښه دی - ستاسو د لیږلو پا pageې لپاره د تادیې توکو ارزښت لري.
د توضیحاتو ماډل ته لیږل کیږي، پروسس کیږي، او له مینځه وړل کیږي. نه ذخیره کیږي، د روزنې لپاره نه کارول کیږي. د اعظمي محرمیت لپاره Qwen 3 کوډر - د Free.ai GPUs کې ځان کوربه کول.
هو - د README سیسټم پروموشن سره / v1 / chat / ته POST (ډول + اوږدوالی + ټون + د برخې بیرغونه) او د پروژې توضیحات د کارونکي پیغام په توګه. د پروژې د سکاولو په جریان کې د README نسل اتومات کولو لپاره ګټور. وګورئ / api /.
تاسو به دا توکي څنګه درجه بندي کړئ؟
5.0/5 from 1 rating