Penjana README
Penggunaan komersial OK
380+ model
Tiada tanda air
Tiada pendaftaran diperlukan
Model:
+ GPT-5, Claude, Gemini
Huraikan projek anda (atau tampal package.json / pyproject.toml / Cargo.toml) dan dapatkan README.md yang disempurnakan — tajuk, perisai, pasang, permulaan pantas, ciri, sumbangan, lesen. Pilih jenis projek, panjang, dan nada anda.
Opsyen Lanjutan
Hasil
Token semakin habis.
Dapatkan Lebih Token
❤️ Love this tool? Share it!
Mendaftar untuk mendapatkan pautan rujukan dan memperoleh 25,000 token per rakan.
Nak lagi?
Daftar percuma untuk 30K token/hari + 10K bonus
Daftar Masuk
Memproses permintaan anda...
Janakan fail README projek dengan AI percuma. Dokumentasi profesional dalam beberapa saat.
Bagaimana untuk Guna Penjana README
1
Masukkan input anda
Taip teks, muat naik fail, atau jelaskan apa yang anda mahu. Tiada akaun diperlukan.
2
Klik cipta
AI kami memproses permintaan anda dalam beberapa saat menggunakan model sumber terbuka terbaik.
3
Muat turun & kongsi
Muat turun, salin, atau kongsi hasil anda. Muat turun percuma untuk kegunaan peribadi dan komersial.
Guna alat ini melalui API
Automatikkan alat ini dari kod anda sendiri. Titik akhir REST serasi OpenAI, pengesahan token-pemegang, tiada SDK tambahan diperlukan. Kos token sepadan dengan antaramuka web.
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."}]}'Alat AI Percuma yang Serupa
Penjana README — FAQ
Huraikan projek anda dalam 2-3 ayat (atau tampal package.json / pyproject.toml / Cargo.toml) dan dapatkan README.md yang digilap — tajuk, lencana perisai, jadual kandungan, pasang, permulaan pantas, ciri-ciri, penggunaan, bahagian berkongsi / lesen / FAQ opsyenal. Pilih jenis projek (pustaka / CLI / webapp / API / mudah alih / plugin / dataset / kertas / templat), panjang (minimum → lengkap), dan nada (profesional / mesra / teknikal / pemasaran / akademik).
readme-so dan makeareadme.com adalah templat isi-bentuk — anda menandai kotak secara manual dan mendapatkan bahagian stok. Free.ai adalah generatif — ia menulis salinan spesifik kepada projek ANDA, menyimpulkan arahan pemasangan yang munasabah / bentuk API / nada dari keterangan anda. Copilot ($10/mo) adalah IDE dalam baris dan menghasilkan README teks perenggan demi perenggan seperti yang anda taip; Free.ai menghasilkan keseluruhan fail dalam satu tembakan. Gunakan readme-so untuk struktur murni; Free.ai apabila anda mahukan salinan sebenar.
Prompt sistem secara eksplisit melarang mencipta ciri-ciri. Jika huraian kabur, model memasukkan tempat letak "TODO". Sentiasa baca README yang dijana dan buang TODO (atau ganti dengan kandungan sebenar) sebelum menerbitkan — anggap output sebagai draf pertama yang disempurnakan, bukan fail sedia untuk dihantar.
Ya bila ditanda — baris 3-6 perisai (bina, versi, lesen, muat turun, liputan) menggunakan URL tempat letak yang anda suaikan ke repositori anda. Model memilih default yang masuk akal berdasarkan jenis projek (pustaka dapat versi npm atau versi pypi; CLI dapat kiraan pemasangan; webapp dapat masa operasi).
Minima (10 baris) untuk utiliti dalaman yang tidak akan dikesan. Piawai (~80 baris) untuk kebanyakan projek sumber terbuka — mencapai titik manis kebolehtelapan tanpa dinding teks. Terperinci (~200 baris) untuk projek yang anda aktif pasarkan. Komprehensif (gaya-dokumen, 300+ baris) apabila README adalah laman dok utama anda.
Ya — pilih nada "Pemasaran". Anda akan mendapat tajuk yang kuat, salinan yang dipandu oleh manfaat, tempat letak bukti sosial, CTAs yang lebih kuat. Bahagian tetap tepat (tiada ciri-ciri dicipta) tetapi prosa adalah gaya-pitching. Baik untuk repos pelancaran SaaS, projek portfolio, rilis gaya-buruan produk.
Ya — pilih nada "Akademik". README termasuk bahagian "Petik" dengan templat BibTeX dan baris permintaan-jika-digunakan, ditambah kaedah dan medan kebolehulangan. Baik untuk repositori kertas penyelidikan dan rilis model / dataset.
Ya — panel hasil mempunyai butang togol Markdown/Pralihat. Pralihat merender sisi klien dengan subset berlauk GitHub (pengepala, tebal/ital, blok kod, kod dalam baris, senarai, pautan). Tidak secemerlang seperti GitHub sendiri — sentiasa lakukan ujian akhir dengan menekan ke repositori.
Penjana lalai menganggap README projek tunggal. Untuk README akar monorepo, jelaskan repo sebagai monorepo dalam input anda ("memiliki 3 pakej: foo, bar, baz") — model menambah jadual pakej dan melepasi arahan pemasangan (kerana pemasangan adalah per-pakej). Untuk README per-pakej, jalankan alat sekali per pakej.
Qwen 3 Pengekod (percuma, piawai) mengendalikan 95% README dengan baik. Qwen 3 30B lebih digilap dan seimbang dalam nada pemasaran. Premium Claude Sonnet 4 lebih baik pada salinan nada pemasaran dan README panjang lengkap — berbaloi dengan token berbayar untuk repositori halaman destinasi anda.
Huraian dihantar ke model, diproses, dan dibuang. Tidak disimpan, tidak digunakan untuk latihan. Untuk privasi maksimum pilih Qwen 3 Pengekod — dihost sendiri pada GPU Free.ai.
Ya — POST ke /v1/chat/ dengan prompt sistem README (jenis + panjang + nada + bendera seksyen) dan keterangan projek sebagai mesej pengguna. Berguna untuk mengotomatisasikan penjanaan README semasa pembinaan projek. Lihat /api/.
Bagaimana anda menilai alat ini?
5.0/5 from 1 rating