Sammendrag — Hva gratis README-generator gjør
Hva dette gratisverktøyet er
Gratis README-generator bygger en perfekt GitHub README.md fra et kort skjema. Velg en mal (Minimal, Standard, Bibliotek eller Webapp), fyll inn prosjektnavn, beskrivelse, forfatter, installasjonskommando og brukskode — og fa en polert README pa sekunder. Merker, lisens, bidragsseksjon og testseksjon er alle en bryter unna.
Personvern: Dette verktøyet kjører helt i nettleseren din. Teksten din blir aldri lastet opp, logget eller bufret. Lukk fanen og den er borte. Verifiser i DevTools → Network: ingen forespørsler sendes.
Hvorfor det er gratis (og hvordan vi holder det gratis)
Gode README-er er forskjellen mellom et apenkildekodeprosjekt folk bruker og et folk glemmer. Vi vil at hvert gratis verktoy, hvert indie-bibliotek, hvert sideprosjekt skal ha en anstendig README. Det er derfor dette er gratis for alltid.
Brukstabell
Hurtigreferanse
| Inndata | Utdata | Typisk størrelse | Hastighet | Pålogging nødvendig |
|---|
| Form fields | README.md (GitHub-ready) | Any project | Real-time | No |
README-generator — Funksjoner
Her er hva dette gratisverktøyet gjør i detalj — hver funksjon er bygget for å løse reelle problemer, kjører helt i nettleseren din, og er gratis for alltid.
4 prosjektmaler for forskjellige prosjekttyper
Velg malen som matcher prosjektet ditt: Minimal (tittel + beskrivelse + lisens, for sma verktoybiblioteker), Standard (legger til funksjons- og bruksseksjoner, for typiske apenkildekodeprosjekter), Bibliotek (legger til en API-seksjon med funksjonssignaturer, for gjenbrukbare biblioteker), eller Webapp (legger til en Kom i gang-seksjon med repo-klone + dev-server-instruksjoner). Hver mal forhåndsutfyller de riktige seksjonene slik at du ikke stirrer pa en blank fil.
Nar du har README-teksten, kan du gjengi den til HTML med Gratis Markdown til HTML-konverterer for a forhåndsvise hvordan den vil se ut pa prosjekthjemmesiden din.
Autogenererte Shields.io-merker
Sla pa Inkluder merker for a legge til en rad shields.io-merker overst i README-en din — npm-versjon, lisens og GitHub Actions-byggestatus. Merkene genereres fra prosjektnavnet og GitHub-brukernavnet ditt, sa de oppdateres automatisk nar prosjektet er publisert. Du kan legge til flere merker manuelt etter kopiering (nedlastinger, dekning, avhengigheter, Discord, Patreon, osv.).
For en innholdsfortegnelse som lenker til hver README-seksjon, bruk Gratis Markdown TOC-generator pa den genererte utdataen.
Lisensvelger med 6 apenkilde-alternativer
Velg fra MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC eller Unlicense — de 6 vanligste apenkilde-lisensene. README-ens lisensseksjon oppdateres umiddelbart, og hvis merker er aktivert, oppdateres lisensmerket for a matche. For andre lisenser eller egendefinerte arrangementer, rediger lisensseksjonen etter kopiering.
Hvis prosjektets README trenger a inkludere tabeller (funksjonssammenligninger, konfigurasjonsalternativer, miljovariabler), bygger Gratis Markdown-tabellgenerator dem visuelt.
Valgfrie bidrags- og testseksjoner
Sla Bidra-seksjonen pa eller av for a inkludere en inviterende tekst som oppfordrer til pull requests og feilrapporter. Sla Tester-seksjonen pa for a inkludere instruksjoner for a kjore testpakken (standard er npm test, kan redigeres etter kopiering). Begge er av som standard pa Minimal-malen; pa som standard pa andre. Legg dem til etter behov nar prosjektet vokser.
Etter generering, rydd opp i eventuelle uoverensstemmelser med Gratis Markdown-formaterer.
Slik bruker du gratis README-generator
Steg 1 — Velg en mal
Velg Minimal, Standard, Bibliotek eller Webapp avhengig av prosjekttypen.
Steg 2 — Fyll inn skjemaet
Prosjektnavn, slagord, beskrivelse, forfatter, installasjonskommando, brukskode, lisens.
Steg 3 — Sla pa/av valgfrie seksjoner
Legg til eller fjern merker, Bidra- eller Tester-seksjoner.
Hvem kan bruke dette verktøyet
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 stilte spørsmål
Er denne gratis README-generatoren virkelig gratis?
Ja. Alle verktoy pa freemarkdowntools.com er gratis for alltid.
Inkluderer den merker?
Ja. shields.io-merker for npm-versjon, lisens og byggestatus er inkludert som standard. Sla av hvis du ikke vil ha dem.
Hvilke maler er tilgjengelige?
Minimal (tittel + lisens), Standard (legger til funksjoner + bruk), Bibliotek (legger til API-seksjon), Webapp (legger til Kom i gang med repo-klone).
Kan jeg redigere den genererte Markdownen?
Ja. Utdataene er vanlig Markdown — kopier, lim inn og tilpass videre i en hvilken som helst editor.
Lagres dataene mine?
Nei. Verktøyet kjorer 100% i nettleseren din.
Relaterte gratis Markdown-verktøy