README-generator
Kommersiell användning OK
380+ modeller
Inget vattenmärke
Ingen registrering behövs
Förlaga:
+ GPT-5, Claude, Gemini
Beskriv ditt projekt (eller klistra in paketet.json / pyproject.toml / Cargo.toml) och få tillbaka en polerad README.md – titel, sköldar, installera, snabbstart, funktioner, bidragande, licens. Välj din projekttyp, längd och ton.
Avancerade alternativ
Resultat
Tokens börjar ta slut.
Hämta fler tokener
❤️ Love this tool? Share it!
< a href="/signup/" style="color:#16A34A">Registrera dig för att få en referenslänk och tjäna 25 000 polletter per vän.
Vill du ha mer?
Registrera dig gratis för 30K tokens/dag + 10K bonus
Registrera dig gratis
Bearbetning av din begäran...
Skapa projekt README-filer med gratis AI. Professionell dokumentation på några sekunder.
Hur du använder README-generator
1
Ange din inmatning
Skriv text, ladda upp en fil eller beskriv vad du vill. Inget konto behövs.
2
Klicka på generera
Vår AI behandlar din begäran på några sekunder med hjälp av de bästa open-source modellerna.
3
Ladda ner & resurs
Ladda ner, kopiera eller dela ditt resultat. Gratis för personligt och kommersiellt bruk.
Använd det här verktyget via API
Automatisera detta verktyg från din egen kod. OpenAI-kompatibel REST endpoint, Bearer-token auth, ingen extra SDK krävs. Token kostnader matchar webbgränssnittet.
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-generator — FAQ
Beskriv ditt projekt i 2-3 meningar (eller klistra in paketet.json / pyproject.toml / Cargo.toml) och få tillbaka en polerad README.md – titel, sköldbrickor, innehållsförteckning, installera, snabbstart, funktioner, användning, valfritt bidrag / licens / FAQ-sektioner. Välj projekttyp (library / CLI / webapp / API / mobil / plugin / dataset / papper / mall), längd (minimal → uttömmande), och ton (professionell / vänlig / teknisk / marknadsföring / akademisk).
readme-so och makeareadme.com är formulär-fill mallar – du manuellt kryssa rutor och få lager sektioner. Free.ai är generativ – det skriver kopia specifik för ditt projekt, sluta rimlig installera kommandon / API form / ton från din beskrivning. Copilot ($10/mo) är inline-IDE och genererar README text stycke för stycke som du skriver; Free.ai producerar hela filen i ett enda skott. Använd readme-så för ren struktur; Free.ai när du vill ha verklig kopia.
Systemprompten förbjuder uttryckligen uppfinnande funktioner. Om beskrivningen är vag, infogar modellen "TODO" platshållare. Läs alltid den genererade README och ta bort TODOs (eller ersätt med faktiskt innehåll) innan publicering – behandla utmatningen som ett polerat första utkast, inte en fartygsklar fil.
Ja när det är markerat — en rad med 3-6 sköldar (bygga, version, licens, nedladdningar, täckning) med platshållares webbadresser som du anpassar till ditt repo. Modellen väljer förnuftiga standardvärden baserat på projekttyp (bibliotek får npm-version eller pypi-version; CLI får install count; webbappen får drifttid).
Minimal (10 rader) för interna verktyg ingen kommer att upptäcka. Standard (~80 rader) för de flesta öppen källkod projekt - träffar den söta platsen för hittabarhet utan väggar av text. Detaljerad (~200 rader) för projekt du aktivt marknadsför. Uttömmande (docs-stil, 300 + rader) när README är din primära dokument webbplats.
Ja — välj "marknadsföring" ton. Du får en stark rubrik, fördel-ledd kopia, socialt säkra platshållare, starkare CTAs. Avsnitten förblir korrekt (inga uppfunna funktioner) men prosa är pitch-stil. Bra för SaaS lansera repo, portfölj projekt, produkt-jakt-stil släpper.
Ja — Välj "Akademisk" ton. README innehåller en "Citation" sektion med en BibTeX mall och en begäran-om-använd linje, plus metoder och reproducerbarhet fält. Bra för forskningspapper repo och modell / dataset utgåvor.
Ja — resultatpanelen har knapparna Markdown/Preview. Förhandsgranskning gör klientsidan med en GitHub-färgad delmängd (rubriker, fetstil, kodblock, inline-kod, listor, länkar). Inte lika polerad som GitHub själv – gör alltid ett sluttest genom att trycka på en repo.
Standardgeneratorn förutsätter ett enda projekt README. För en monorepo root README, beskriv repo som en monorepo i din inmatning ("innehåller 3 paket: foo, bar, baz") – modellen lägger till en pakettabell och hoppar över installationsinstruktioner (eftersom installation är per paket). För READMEs per paket, kör verktyget en gång per paket.
Qwen 3 Coder (free, standard) hanterar 95% av READMEs väl. Qwen 3 30B är mer polerad och balanserad i marknadsföringston. Premium Claude Sonnet 4 är märkbart bättre på marknadsföring-ton kopia och uttömmande längd READMEs - värt de betalda polletter för din landning sida repo.
Beskrivningen skickas till modellen, bearbetas och kasseras. Ej lagrad, används inte för utbildning. För maximal sekretess pick Qwen 3 Coder – självvärdig på Free.ai's GPUs.
Ja – POST till /v1/chat/ med README systemprompten (typ + längd + ton + sektionsflaggor) och projektbeskrivningen som användarmeddelande. Användbar för att automatisera README-generering under projektställningar. Se /api/.
Hur skulle du värdera det här verktyget?
5.0/5 from 1 rating