የ README ማውጫ
የኮሜርስ
581 ሞዴሎች
የዋሽንግተን
ምዝገባ የለም
ሞዴል፦
+ GPT-5, Claude, Gemini
ፕሮጀክቱን ግለጽ (ወይም package.json / pyproject.toml / Cargo.toml) እና የተሻሻለ README.md ይያዙ - አርእስት፣ ሽፋኖች፣ ማስቀመጥ፣ የትኩረት ቦታ፣ ባህሪያት፣ አስተዋፅኦ፣ ፈቃድ. የፕሮጀክቱን ዓይነት፣ ርዝመት እና ድምፅ ይምረጡ።
የቀረቡ ምርጫዎች
ውጤት
ቶኬቶች እየቀነሱ ነው
ተጨማሪ ቶኬቶች
የበለጠ ይፈልጋሉ?
ነጻ ምዝገባ: 30,000 ቶኮን / ቀን
ነጻ
ጥያቄዎን በመቀበል ላይ...
የፕሮጀክት README ፋይሎችን ነጻ AI ጋር ማምረት. በሁለት ሰከንዶች ውስጥ የሙያ ማስረጃዎች.
እንዴት እንደሚጠቀሙ የ README ማውጫ
1
የእርስዎን ፋይል አስገባ
ጽሑፉን ይጻፉ፣ ፋይልን ጫን፣ ወይም የሚፈልጉትን ነገር ግለጹ። ምንም ዓይነት ሂሳብ አይጠየቅም
2
መተላለፊያ
የ AI መሳሪያችን በሁለት ሰከንዶች ውስጥ ጥያቄዎን በመጠቀም ምርጥ የግል-መነሻ ሞዴሎችን ይጠቀማል.
3
መተላለፊያ
ያውርዱ፣ ቅጂ፣ ወይም ውጤትዎን ይተላለፉ. ነፃ ለግል እና የቢዝነስ ጥቅም.
ይህ መሣሪያን በAPI ይጠቀሙ
ይህ መሣሪያ ከራስዎ ኮድ አውቶማቲክ. OpenAI-ተስማሚ REST መጨረሻ ነጥብ, Bearer-ቶኬን auth, ምንም ተጨማሪ 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 ነው generative - ይህ ለፕሮጀክትዎ የተወሰነ ቅጂ ይጽፋል, ጠቃሚ ማስቀመጥ ትዕዛዞች / API ቅርፅ / tone ከ መግለጫዎ. Copilot ($ 10 / ወር) ነው inline-IDE እና README ጽሑፍ ገጽ በ ገጽ እንደ ትጽፋለህ; Free.ai በአንድ ፎቶ ውስጥ ሙሉ ፋይልን ያመርታል. readme-so ን ለጥሩ ግንባታ ይጠቀሙ; Free.ai እውነተኛ ቅጂ ይፈልጋሉ ጊዜ.
የሲስተም ማስጠንቀቂያ በግልጽ የፈጠራ ባህሪያትን ይከለክላል. መግለጫው ግልጽ ካልሆነ፣ ሞዴሉ "TODO" ቦታዎችን ያስገባል. ሁልጊዜ የተፈጠረውን README አንብቡ እና TODOs ን ከመለጠፍዎ በፊት ያስወግዱ (ወይም በእውነተኛው ይዘት ይለውጡ) - ውጤቱን እንደ የመጀመሪያው ቀላል ቀረጻ አድርገው ይቆጥሩ፣ ፋይልን ለመላክ ዝግጁ አይደለም።
አዎ ወቅት ተመልከቱ - 3-6 መስመር ሺሎች (መገንባት, ስሪት, ፈቃድ, ያውርዱ, መከታተል) በመጠቀም placeholder URLs ወደ repoዎ ማስተካከል. ሞዴል በፕሮጀክት ዓይነት ላይ የተመሠረተ ጠቃሚ መነሻዎች ይመርጣል (መጽሐፍት npm-ስሪት ወይም pypi-ስሪት ያገኛል; CLI ያስገቡ ቁጥር ያገኛል; ዌብአፕ አፕቲም ያገኛል).
ቢያንስ (10 መስመር) ለውስጠኛ ጠቃሚዎች ማንም አይገኝም. መደበኛ (~80 መስመር) ለብዙዎቹ የክፍል-መነሻ ፕሮጀክቶች - የጽሑፍ ግድግዳዎች ሳይኖሩ የማግኘት ችሎታውን የፍቅር ቦታን ያገኛል. ለፕሮጀክቶች በጥብቅ የምትሸጡበት ዝርዝር (~200 መስመር). README የእርስዎ ዋና የጽሑፍ ጣቢያ ከሆነ ሙሉ (የጽሑፍ-ስርዓት, 300+ መስመር)
አዎ - "ማህበራዊ" ድምፅ ይምረጡ. ጠንካራ አርእስት, ጥቅም-ተመራ ቅጂ, ማህበራዊ-ተረጋጋ ቦታዎች, ጠንካራ CTAዎች ማግኘት. ክፍሎች ትክክለኛ ይቆያሉ (አልተፈጠረ ባህሪያት) ነገር ግን ፀሐፊው ፒክ-ስታይ ነው. ለ SaaS መጀመሪያ repos, የፖርትፎሊዮ ፕሮጀክቶች, ምርት-በግ-ስታይ ማውጣት.
አዎ - "አካዳሚክ" ድምፅ ይምረጡ. README BibTeX ንድፍ እና ጥያቄ-እንደ-ተጠቀመ መስመር, ተጨማሪ ዘዴዎች እና መቀየር ሜዳዎች ጋር "መጥቀስ" ክፍል ያካትታል. ለ ምርምር ወረቀት repos እና ሞዴል / ዳታሴት ማውጣት.
አዎ - የመጨረሻው ፋይል ማክዶን/ቅድመ ዕይታ ተለዋዋጭ ቁልፎች አለው. ቅድመ ዕይታ የ GitHub- flavored subset (አርእስቶች, ጠንካራ/አቀማመጥ, ኮድ ክፍሎች, በመስመር ኮድ, ዝርዝሮች, አገናኞች) ጋር የክላሲካል ጎን ይመለከታል. እንደ GitHub ብቻ አይደለም - ሁልጊዜ ወደ ሪፖ ወደ መውጣት የመጨረሻ ሙከራ ያደርጋሉ.
ቅድመ-ተቆጣጣሪው ገንቢ አንድ ፕሮጀክት README ያደርጋል. ለ monorepo root README, ሪፖውን እንደ monorepo በእርስዎ ፋይል ውስጥ ("3 ጥቅሎችን ይዟል: foo, bar, baz") - ሞዴል ጥቅሎችን ሰንጠረዥ ይጨምራል እና ማስቀመጥ መመሪያዎችን ይለቅቃል (እንደ ማስቀመጥ በእያንዳንዱ ጥቅል ነው)። ለእያንዳንዱ ጥቅል READMEs, ለእያንዳንዱ ጥቅል አንድ ጊዜ መሳሪያውን ይጫኑ
የኩዌን 3 ኮዴር (ነፃ, መነሻ) የ READMEs 95% ን ይይዛል. የኩዌን 2.5 7B ትንሽ ፈጣን ነው ግን በሽያጭ ድምፅ ውስጥ በጣም ጥሩ አይደለም. ፕሪሚየም ክላውድ ሶኔት 4 በሽያጭ-ድምፅ ቅጂ እና በሙሉ-ርዝመት READMEs ላይ በጣም የተሻለ ነው - ለእርስዎ የመነሻ ገጽ ሪፖ የተከፈለውን ቶኮኖችን ያህል.
መግለጫው ወደ ሞዴሉ ተልከዋል፣ ተሠራ፣ ተጣለ። አልተጠበቀም፣ ለተለማመጃ አልተጠቀመም። ለከፍተኛ የግልነት ልዩነት Qwen 3 ኮዴክተርን ይምረጡ - በ Free.ai GPUs ላይ በራሱ የተቀመጠ።
አዎ - POST ወደ /v1/chat/ ጋር README የሲስተም ጥያቄ (ዓይነት + ርዝመት + ድምፅ + ክፍል ቀለሞች) እና የፕሮጀክት መግለጫ እንደ ተጠቃሚ መልዕክት. ለራስ-ሰር README መፍጠር በፕሮጀክት scaffolding ጊዜ ጥቅም ላይ. /api/ ይመልከቱ.
ይህ መሣሪያ እንዴት ነው የምትመዘግበው?