README-generator

Kommersiell bruk OK 380+ modeller Intet vannmerke Ikke nødvendig å logge inn
Modell:
+ GPT-5, Claude, Gemini
Beskriv prosjektet (eller lim inn pakke.json / pyproject.toml / Cargo.toml) og kom tilbake en polert README. md — tittel, skjermer, installasjon, hurtigstart, funksjoner, bidragende, lisens. Velg prosjekttype, lengde og tone.
Inkluder:
Beskriv prosjektet ditt.
README.md

        
Avanserte valg
Resultat
Tegn som er nesten tomt. Hent flere symboler
Vil du ha bedre resultater? Premiemodeller (GPT-5, Claude, Gemini) leverer høyere kvalitet. Vis planer

❤️ Love this tool? Share it!

Tilmeld deg for å få en henvisningslenke og tjene 25.000 mynter per venn.

Vil du ha mer? Registrer deg gratis for 30K mynter/dag + 10K bonus
Registrer deg gratis

Behandler din forespørsel...

Lag prosjekt- README- filer med fri AI. Professionell dokumentasjon på sekunder.

Bruksmåte README-generator

1
Skriv inn dine inndata

Skriv inn tekst, last opp en fil eller beskriv hva du vil ha. Ingen konto trengs.

2
Trykk Lag

Vår AI behandler din forespørsel i sekunder med de beste open- source modellene.

3
Last ned & ressurs

Last ned, kopier eller del resultatet ditt. Gratis for personlig og kommersiell bruk.

Bruk dette verktøyet via API

Automatiser dette verktøyet fra din egen kode. OpenAI- kompatible REST endepunkt, Bearer- token auth, ikke nødvendig med ekstra SDK. Tegnkostnader stemmer med nettgrensesnittet.

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 prosjektet i 2-3 setninger (eller lim inn pakke.json / pyproject.toml / Cargo.toml) og kom tilbake en polert README.md – tittel, skjermskilt, innholdsliste, installasjon, hurtigstart, funksjoner, bruk, valgfri bidrags- / lisens - / FAQ - seksjoner. Velg prosjekttype (bibliotek / CLI / webapp / API / mobil / programtillegg / datasett / papir / mal), lengde (minimal → uttømmende), og tone (yrkesvennlig / teknisk / markedsføring / akademisk).

readme-so og makeareadme.com er skjemafyllingsmaler – du krysser av i boksene manuelt og får lagerseksjoner. Free.ai er generativt – det skriver en kopi som er spesifikk for prosjektet ditt, og ut fra en rimelig installasjonskommando / API- form / tone fra beskrivelsen din. Copilot ($10/mo) er inne i teksten og lager et avsnitt i teksten etter avsnitt mens du skriver; Free.ai produserer hele fila i ett forsøk. Bruk readme- så for ren struktur; Free.ai når du vil ha selve kopien.

Systemet forbyr uttrykkelig oppfinning av funksjoner. Hvis beskrivelsen er uklar, så setter modellen inn « TODO » - plassholdere. Les alltid de genererte README og fjern TODO- er (eller erstatt med virkelig innhold) før publisering. Utdata behandles som et polert første utkast, ikke som en fil som er klar for skipet.

Ja når dette er krysset av – en rad på 3-6 skjermer (bygge, versjon, lisens, nedlastinger, dekning) med plassholder- URL- er du tilpasser til gjenoppbyggingen. Modellen velger fornuftig standard basert på prosjekttype (bibliotek får npm- version eller pypi- versjon; CLI får installasjonstall; webapp får opptid).

Minste (10 linjer) for interne verktøy blir ingen oppdaget. Standard (~80 linjer) for de fleste prosjekter med åpen kildekode – treffer det søte stedet å finne uten vegger av tekst. Detaljerte (~200 linjer) for prosjekter du markedsfører aktivt. Utmattende (docs- stil, 300+ linjer) når README er ditt primære dokument- nettsted.

Ja, velg « Marketing » - tone. Du får en sterk overskrift, nytte- ledet kopi, sosialt sikre plassholdere, sterkere CTA- er. Avsnittene holder seg nøyaktige (ingen oppfinnede egenskaper) men prosen er en tone- stil. Bra for SaaS- lansering, porteføljeprosjekter, utgivelser i produkt- hunt- stil.

Ja, velg « Aakademisk » - tone. README inneholder et avsnitt om « Sitat » med en BibTeX- mal og en linje der forespørselen brukes, pluss metoder og reproduserbarhetsfelter. Godt for gjenkjøp av forskningspapirer og modell / dataset- utgaver.

Ja, resultatpanelet har knappene Merke/ Forhåndsvis. Forhåndsvis viser klientsiden med et undersett med GitHub- flavor (overskrifter, halvfet/italisiske, kodeblokker, inline- kode, lister, lenker). Ikke så polert som GitHub selv – gjør alltid en endelig test ved å trykke til en gjenpart.

Standardgeneratoren antar en README med ett prosjekt. For en mono- rot- README, beskriv repo som en monorepo i inndata- teksten (« inneholder 3 pakker: foo, bar, baz ») – modellen legger til en pakketabell og hopper over installasjonsinstrukser (fordi installasjon er for hver pakke). Kjør verktøyet en gang for hver pakke.

Qwen 3 Koder (fri, standard) håndterer 95 % av README. Qwen 3 30B er mer polert og balansert i markedsføringstone. Premium Claude Sonnet 4 er merkbart bedre i markedsføringstonekopi og uttømmende lengde README – verdt de betalte symbolene for din repo på landingssiden.

Beskrivelsen sendes til modellen, behandles og kasseres. Ikke lagret, ikke brukt til opplæring. For maksimalt utvalg av personvern Qwen 3 koder – selvvertert på Free.ai GPU- er.

Ja – POST til / v1/ Chat/ med README- systemprompt (type + lengde + tone + avsnittsflagg) og prosjektbeskrivelsen som brukermelding. Nyttig for automatisering av README- generering under prosjektposisjoner. Se / api /.

Registrer deg gratis for 30 000 mynter

Lag ledig konto

Ikke påkrevd med kredittkort

Hvordan vil du vurdere dette verktøyet?

5.0/5 from 1 rating

Love this tool? Share it!