Генератори README
Истифодаи тиҷоратӣ
Намунаҳои 581
& Ишораи обӣ
Бақайдгирӣ лозим нест
& Намуна:
+ GPT-5, Claude, Gemini
Лоиҳаи худро тавсиф кунед (ё package.json / pyproject.toml / Cargo.toml-ро ҷойгир кунед) ва README.md-и тозашударо баргардонед — сарлавҳа, аломатҳо, насбкунӣ, оғози зуд, хусусиятҳо, саҳмгузорӣ, иҷозатнома. Намуди лоиҳаро, дарозии онро ва садои онро интихоб кунед.
Интихобҳои иловагӣ
Натиҷа
Нишонаҳои кам.
Гирифтани нишонаҳои бештар
❤️ Шумо дӯст медоред Free.ai? Ба дӯстонатон бигӯед!
Register барои гирифтани пайвандҳои тавсияшаванда ва 30,000 нишондиҳанда барои ҳар як дӯст.
Боз ҳам мехоҳед?
Бақайдгирии ройгон: 30,000 нишонаҳо/рӯз
Бақайдгирӣ
Коркарди дархости шумо...
Эҷоди файлҳои README- и лоиҳа бо AI- и озод. Ҳуҷҷатгузории касбӣ дар якчанд сония.
Чӣ тавр истифода бурдани Генератори README
1
Вводите свой ввод
Матнро ворид кунед, файлро бор кунед ё он чиро, ки мехоҳед, тавсиф кунед. Ҳисоби корбарӣ лозим нест.
2
Сохтани клик
Ин раванди гузариш аз як шакли раванди ибтидоӣ ба шакли раванди раванди ниҳоӣ ном дорад.
3
Боркунӣ ва тақсимкунӣ
Боргирӣ, нусха бардоред ё натиҷаи худро мубодила кунед. Барои истифодаи шахсӣ ва тиҷоратӣ ройгон аст.
Истифодаи ин асбоб тавассути API
Ин асбобро аз коди худ худкор созед. Нуқтаи охирини REST-и мувофиқи OpenAI, аутентификатсияи Bearer-token, SDK-и иловагӣ лозим нест. Нархҳои Token ба интерфейси веб мувофиқат мекунанд.
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-ро ба даст оред - сарлавҳа, нишонаҳои муҳофизатӣ, рӯйхати мундариҷа, насбкунӣ, оғози зуд, хусусиятҳо, истифода, қисмҳои иловагии саҳмгузорӣ / иҷозатнома / FAQ. Намуди лоиҳаро интихоб кунед (китобхона / CLI / webapp / API / мобилӣ / плагин / маҷмӯи маълумот / коғаз / қолиб), дарозӣ (минималӣ → пурра) ва оҳанг (профессионалӣ / дӯстона / техникӣ / маркетинг / академӣ).
readme- so ва makeareadme. com қолибҳои пуркунии шакл мебошанд — шумо дар дастгоҳ қуттиҳоро қайд карда, қисмҳои захиравӣ мегиред. Free.ai генеративӣ аст — он нусхаи махсуси лоиҳаи шуморо менависад, фармонҳои насбкунии мувофиқ / API шакл / садоро аз тавсифи шумо бармеорад. Copilot ($10/ mo) ин IDE- и дар сатр буда, README- матни абзац ба абзацро ҳангоми чопкунӣ эҷод мекунад; Free.ai тамоми файлро дар як лаҳза истеҳсол мекунад. Барои сохтори тоза readme- so- ро истифода баред; Free.ai, вақте ки шумо нусхаи воқеиро мехоҳед.
Системаи саволӣ ба таври равшан сохтани хусусиятҳоро манъ мекунад. Агар тавсифот номаълум бошад, намуна ҷойҳои "ТОД" - ро дохил мекунад. Ҳамеша README- ро хонед ва пеш аз нашр кардани TODO- ро хориҷ кунед (ё бо мундариҷаи воқеӣ иваз кунед) - хурӯҷро ҳамчун сиёҳии аввала, на файли омодаи фиристодан, қабул кунед.
Ҳа, вақте ки интихоб шудааст — қатори 3-6 сақфҳо (сохт, версия, иҷозатнома, боргирӣ, фарогирӣ) бо истифодаи URL-ҳои ҷойгузин, ки шумо ба репозиторияи худ танзим мекунед. Намуна пешфарзҳои мувофиқро дар асоси намуди лоиҳа интихоб мекунад (китобхона версияи npm ё версияи pypi-ро мегирад; CLI шумораи насбкуниро мегирад; webapp вақти корро мегирад).
Миқдори кам (10 сатр) барои воситаҳои дохилӣ, ки касе онҳоро пайдо намекунад. Стандартӣ (~80 сатр) барои бисёр лоиҳаҳои кушодаи сарчашма - ба нуқтаи дурусти пайдошаванда бе девори матнҳо мерасад. Муфассал (~200 сатр) барои лоиҳаҳое, ки шумо фаъолона фурӯш мекунед. Мукаммал (дар шакли ҳуҷҷатҳо, 300+ сатр) вақте ки README сайти ҳуҷҷатҳои асосӣ мебошад.
Да — тон "Маркетинг" интихоб кунед. Шумо унвони қавӣ, нусхаи фоиданок, ҷойҳои иҷтимоӣ, CTA- и қавитар мегиред. Қисми дақиқ (бе хусусиятҳои кашфшуда) боқӣ мемонад, аммо проза ба тарзи пич- стил аст. Барои оғози SaaS repos, лоиҳаҳои портфолио, навсозиҳои намуди ҷустуҷӯи маҳсулот хуб аст.
Да - тон "Академик" интихоб кунед. README дар бар мегирад "Ситати" қисм бо BibTeX қолиб ва талабот- агар истифода бурда шуд хат, илова бар усулҳо ва бозсозии майдонҳо. Барои тадқиқотӣ ҳуҷҷат репозитория ва модел / dataset озод.
Ҳа - панели натиҷа тугмаҳои Markdown/Пешнамоиш дорад. Пешнамоиш дар тарафи муштарӣ бо зергурӯҳи GitHub-и лаззатбахш (сарлавҳаҳо, ғафс/курсив, блокҳои код, коди дар сатр, рӯйхатҳо, пайвандҳо) тасвир мекунад. На он қадар хуб, ки худи GitHub - ҳамеша санҷиши ниҳоиро бо пахши ба репозитория иҷро кунед.
Генератори пешфарз README-и як лоиҳаро қабул мекунад. Барои README-и решаи monorepo, репозиторияро ҳамчун monorepo дар воридот ("3 бастаро дар бар мегирад: foo, bar, baz") тасвир кунед - модел ҷадвали бастаҳоро илова мекунад ва дастурҳои насбкуниро гузаронида намешавад (азбаски насбкунӣ барои ҳар як баста аст). Барои README-ҳои ҳар як баста, асбобро як маротиба барои ҳар як баста иҷро кунед.
Qwen 3 Coder (ройгон, пешфарз) 95% README-ҳоро хуб идора мекунад. Qwen 3 30B дар маркетинги оҳанг бештар тоза ва мувозинатро таъмин мекунад. Premium Claude Sonnet 4 дар маркетинги оҳанг нусхаи беҳтар ва README-ҳои дарозии пурра дорад - арзиши ройгони барои репозиторияи саҳифаи шумо.
Тасвирот ба намуна фиристода мешавад, коркард карда мешавад ва барҳам дода мешавад. На захира карда мешавад, на барои омӯзиш истифода мешавад. Барои махфияти максималӣ Qwen 3 Рамзгузорро интихоб кунед - худи соҳиб дар Free.ai GPUs.
Да - POST ба / v1/ chat / бо системаи README (навъи + дарозии + садо + қисми байрақҳо) ва лоиҳаи тавсиф ҳамчун паёми корбар. Барои худкор сохтани README дар вақти лоиҳа сохтан. / api/ - ро бинед.
Шумо ин асбобро чӣ гуна баҳо медиҳед?