Oversigt — Hvad gratis README-generator gør
Hvad dette gratis værktøj er
Gratis README-generator bygger en perfekt GitHub README.md fra en kort formular. Vaelg en skabelon (Minimal, Standard, Bibliotek eller Webapp), udfyld projektnavn, beskrivelse, forfatter, installationskommando og brugskode — og fa en poleret README pa sekunder. Badges, licens, bidragssektion og testsektion er alle en kontakt vaek.
Privatliv: Dette værktøj kører helt i din browser. Din tekst uploades, logges eller caches aldrig. Luk fanen, og den er væk. Verificer i DevTools → Network: ingen forespørgsler sendes.
Hvorfor det er gratis (og hvordan vi holder det gratis)
Gode README'er er forskellen mellem et open source-projekt folk bruger og et folk glemmer. Vi vil have at hvert gratis vaerktoj, hvert indie-bibliotek, hvert sideprojekt skal have en ordentlig README. Derfor er dette gratis for evigt.
Brugstabel
Hurtigoversigt
| Input | Output | Typisk størrelse | Hastighed | Login kræves |
|---|
| Form fields | README.md (GitHub-ready) | Any project | Real-time | No |
README-generator — Funktioner
Her er hvad dette gratis værktøj gør i detaljer — hver funktion er bygget til at løse rigtige problemer, kører helt i din browser og er gratis for evigt.
4 projektskabeloner til forskellige projekttyper
Vaelg den skabelon der matcher dit projekt: Minimal (titel + beskrivelse + licens, for sma vaerktöjsbiblioteker), Standard (tilfojer funktions- og brugssektioner, for typiske open source-projekter), Bibliotek (tilfojer en API-sektion med funktionssignaturer, for genbrugelige biblioteker), eller Webapp (tilfojer en Kom i gang-sektion med repo-klon + dev-server-instruktioner). Hver skabelon forudfylder de rigtige sektioner sa du ikke stirrer pa en blank fil.
Nar du har README-teksten, kan du gengive den til HTML med Gratis Markdown til HTML-konverter for at forhåndsvise hvordan den vil se ud pa din projekthjemmeside.
Autogenererede Shields.io-badges
Sla Inkluder badges til for at tilfoje en raekke shields.io-badges overst i din README — npm-version, licens og GitHub Actions-byggestatus. Badges genereres fra dit projektnavn og GitHub-brugernavn, sa de opdateres automatisk nar dit projekt er publiceret. Du kan tilfoje flere badges manuelt efter kopiering (downloads, daekning, afhaengigheder, Discord, Patreon, osv.).
For en indholdsfortegnelse der linker til hver README-sektion, brug Gratis Markdown TOC-generator pa det genererede output.
Licensvaelger med 6 open source-muligheder
Vaelg fra MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC eller Unlicense — de 6 mest almindelige open source-licenser. README'ens licenssektion opdateres ojeblikkeligt, og hvis badges er aktiveret, opdateres licensbadgen for at matche. For andre licenser eller brugerdefinerede arrangementer, rediger licenssektionen efter kopiering.
Hvis dit projekts README har brug for at inkludere tabeller (funktionssammenligninger, konfigurationsmuligheder, miljovariabler), bygger Gratis Markdown-tabelgenerator dem visuelt.
Valgfrie bidrags- og testsektioner
Sla Bidrag-sektionen til eller fra for at inkludere en indbydende tekst der opfordrer til pull requests og fejlrapporter. Sla Tests-sektionen til for at inkludere instruktioner til at kore din testpakke (standard er npm test, redigerbar efter kopiering). Begge er fra som standard pa Minimal-skabelonen; til som standard pa andre. Tilfor dem efter behov nar dit projekt vokser.
Efter generering, ryd op i eventuelle uoverensstemmelser med Gratis Markdown-formateringsvaerktoj.
Sådan bruger du gratis README-generator
Trin 1 — Vaelg en skabelon
Vaelg Minimal, Standard, Bibliotek eller Webapp afhaengigt af projekttypen.
Trin 2 — Udfyld formularen
Projektnavn, tagline, beskrivelse, forfatter, installationskommando, brugskode, licens.
Trin 3 — Sla valgfrie sektioner til/fra
Tilfor eller fjern badges, Bidrag- eller Tests-sektioner.
Hvem kan bruge dette værktøj
Open source maintainers
Shipping a polished README for every library release — no more 'figure out how to use this' friction.
Indie developers
Ship side projects with professional READMEs that make them look like real products.
Students building portfolios
Every project on your GitHub profile needs a README. This takes 2 minutes.
Hackathon teams
Ship your hackathon project with a real README even when you're running on 3 hours of sleep.
Technical writers
Starting from a solid template and customizing instead of staring at a blank file.
Ofte stillede spørgsmål
Er denne gratis README-generator virkelig gratis?
Ja. Alle vaerktoj pa freemarkdowntools.com er gratis for evigt.
Inkluderer den badges?
Ja. shields.io-badges for npm-version, licens og byggestatus er inkluderet som standard. Sla fra hvis du ikke vil have dem.
Hvilke skabeloner er tilgaengelige?
Minimal (titel + licens), Standard (tilfojer funktioner + brug), Bibliotek (tilfojer API-sektion), Webapp (tilfojer Kom i gang med repo-klon).
Kan jeg redigere den genererede Markdown?
Ja. Outputtet er almindelig Markdown — kopier, indsaet og tilpas videre i en hvilken som helst editor.
Gemmes mine data?
Nej. Vaerktöjet korer 100% i din browser.
Relaterede gratis Markdown-værktøjer