Генератар README
Камерцыйнае выкарыстанне
380+ мадэляў
Без вадзянога знака
Не патрабуецца рэгістрацыя
Модэль:
+ GPT-5, Claude, Gemini
Апісанне праекту (або ўстаўка package.json / pyproject.toml / Cargo.toml) і атрыманне адрэдагаванага README.md — назва, абарона, ўстаноўка, хуткі запуск, магчымасці, уклад, ліцэнзія. Выберыце тып праекту, даўжыню і тон.
Адмысловыя параметры
Вынікі
Не хапае значкоў.
Атрымаць больш значкоў
❤️ Любіце Free.ai? Раскажыце сваім сябрам!
Зарэгіструйцеся, каб атрымаць спасылку і атрымаць 25 000 знакаў на сябра.
Хочаце больш?
Зарэгіструйцеся бясплатна на 30K знакаў / дзень + 10K бонус
Зарэгіструйцеся
Апрацоўка запыту...
Стварэньне файлаў README праекту з дапамогай чалавечага інтэлекту. Прафэсійная дакументацыя за некалькі секунд.
Як выкарыстоўваць Генератар README
1
Увядзіце ваш увод
Увядзіце тэкст, загрузіце файл або апісайце, што вы хочаце. Не патрабуецца ўліковы запіс.
2
Націсніце, каб стварыць
Нашы машынныя навучанні апрацоўваюць ваш запыт за секунды, выкарыстоўваючы лепшыя мадэлі з адкрытым зыходным кодам.
3
Сцягнуць і падзяліцца
Сцягнуць, скапіраваць або падзяліцца сваімі вынікамі. Бясплатна для асабістага і камерцыйнага выкарыстання.
Выкарыстоўваць гэтую прыладу праз API
Аўтаматызацыя гэтай інструмента з вашага кода. OpenAI- сумяшчальны REST канец, Bearer- токен аўтарызацыі, не патрабуецца дадатковы 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 сказах (або ўстаўце package. json / pyproject. toml / Cargo. toml) і атрымаеце адшліфаваны README. md — загалоўкі, значкі, змест, ўстаноўка, хуткі старт, магчымасці, выкарыстанне, дадатковыя секцыі ўкладу / ліцэнзіі / часта задаваемых пытанняў. Выберыце тып праекта (бібліятэка / CLI / webapp / API / мабільны / утулка / набор дадзеных / папера / шаблон), даўжыню (мінімальная → вычварная) і тон (прафесійны / зручны / тэхнічны / маркетынг / акадэмічны).
readme- so і makeareadme. com - гэта шаблоны для запаўнення формы - вы ўручную адзначаеце квадраты і атрымліваеце запасныя секцыі. Free.ai - гэта генератыўны - ён піша копію, адпаведную ВАШЫМ праектам, выводзячы прыдатныя каманды ўстаноўкі / форму API / тон з вашага апісання. Copilot ($10/ месяц) - гэта ўбудаванае IDE і генеруе README- тэкст па параграфах, як вы ўводзіце; Free.ai выпрацоўвае ўвесь файл за адзін раз. Выкарыстоўвайце readme- so для чыстай структуры; Free.ai, калі вам патрэбна рэальная копія.
Сістэмная запрашэнне выразна забараняе стварэнне магчымасцяў. Калі апісанне няяснае, мадэль устаўляе замест яго "TODO". Заўсёды чытайце сфармаваны README і выдаляйце TODO (або заменіце іх на сапраўдны змест) перад апублікаваннем - лічыце вывад як адшліфаваны першы чарнавік, а не гатовы да выкарыстання файл.
Дазволіць, калі ўключана — радок з 3- 6 шчытоў (збудаванне, версія, ліцэнзія, спампоўка, ахоп) з выкарыстаннем месцаў для URL, якія вы настроілі для вашага рэпазітара. Модэль выбірае правільныя значэнні па змаўчанні, зыходзячы з тыпу праекта (бібліятэка атрымлівае npm- version або pypi- version; CLI атрымлівае колькасць устаноўак; webapp атрымлівае час працы).
Мінімум (10 радкоў) для ўнутраных прыкладанняў, якія ніхто не знойдзе. Стандартны (~ 80 радкоў) для большасці праектаў з адкрытым зыходным кодам - дазваляе знайсці неабходную інфармацыю без вялікіх тэкставых загалоўкаў. Падрабязны (~ 200 радкоў) для праектаў, якія вы актыўна прадаеце. Вычварны (документацыйны стыль, 300+ радкоў), калі README з' яўляецца вашым галоўным сайтам дакументацыі.
Так — выберыце тон "Маркетынг". Вы атрымаеце моцны загалоўак, тэксты, якія падкрэсліваюць выгаду, сацыяльна- бяспечныя замяняльнікі, больш моцныя звароты да дзеяння. Раздзелы застаюцца дакладнымі (няма вынайдзеных функцый), але праза ў стылі пікету. Добра для запуску рэпазіторыяў SaaS, портфоліа праектаў, выпускаў у стылі пошуку прадуктаў.
Так - выберыце "Акадэмічны" тон. README уключае ў сябе раздзел "Цытаты" з шаблонам BibTeX і радком "Запытаць, калі выкарыстана", а таксама палі метадаў і паўтаральнасці. Добра для рэпазіторыяў навуковых работ і выхаду мадэляў / набораў дадзеных.
Так — панель вынікаў мае кнопкі пераключэння Markdown/Прэгляд. Прагляд паказвае на баку кліента падмноства з густам GitHub (загалоўкі, шчыльны/ курсіў, блокі кода, убудаваны код, спісы, спасылкі). Не так гладка, як сам GitHub — заўсёды рабіце канчатковы тэст, адпраўляючы ў рэпазітары.
Генератар па змаўчанні прымае README аднаго праекта. Для README каранёвага рэпазітара monorepo апісвайце рэпазітар як monorepo ў вашым уводзе ("змяшчае 3 пакеты: foo, bar, baz") - мадэль дадае табліцу пакетаў і прапускае інструкцыі ўстаноўкі (паколькі ўстаноўка адбываецца па пакунках). Для README па пакунках запускайце інструмент адзін раз па пакунках.
Qwen 3 Coder (бясплатны, па змаўчанні) добра працуе з 95% README. Qwen 2. 5 7B неяк хутчэй, але менш эстэтычна. Premium Claude Sonnet 4 значна лепш у маркетынгавым тоне і вычварных README - варта плаціць за рэпазітары для вашай мэтавай старонкі.
Апісанне адпраўляецца ў мадэль, апрацоўваецца і адхіляецца. Не захоўваецца, не выкарыстоўваецца для трэніровак. Для максімальнай прыватнасці выберыце Qwen 3 Coder — самастойна ўсталяваны на GPU Free.ai.
Так — POST у / v1/ chat / з сістэмным запытаннем README (тып + даўжыня + тон + сцяг секцыі) і апісаннем праекта як паведамленне карыстальніка. Прыдатна для аўтаматызацыі генерацыі README падчас стварэння праекта. Глядзіце / api /.
Як вы ацэньваеце гэтую прыладу?
5.0/5 from 1 rating