Softonic

README-generator

Stap 1 / 4 README.md
Volgende

Lege repositories maken een slechte eerste indruk. Vul de projectnaam, een slogan van één regel, een lijst met functies, het installatiecommando, een snelstartfragment, de auteur en de licentie in, en deze generator maakt een nette Markdown-README met een correcte kophiërarchie en afgeschermde codeblokken: de secties die GitHub op je projectpagina toont. Kopieer het, sla het op als README.md in de root van je repo en push. De sectiekoppen zijn in het Engels geschreven, de vrijwel universele conventie voor opensource-README-bestanden; je eigen tekst verschijnt precies zoals je hem typt, in welke taal dan ook.

Hoe schrijf je een README

  1. 1

    Voeg de basis toe

    Projectnaam, een optionele repository-URL en een slogan van één regel. De naam wordt de `#`-titel; de slogan wordt het citaat eronder.

  2. 2

    Lijst functies en een snelstart op

    Eén functie per regel (elke wordt een opsommingsteken), plus een kort snelstartfragment dat in een afgeschermd codeblok wordt gezet.

  3. 3

    Installatie, licentie en auteur

    Het installatiecommando komt in een `bash`-codeblok onder Installation; voeg de licentie (MIT, Apache-2.0…) en een optionele auteursregel toe.

  4. 4

    Kopieer de Markdown

    Klik op kopiëren en plak de uitvoer als `README.md` in de root van je repo. Push en de gerenderde versie verschijnt op de projectpagina.

Wat een goede README bevat

Zowel de eigen stijlgids van GitHub als de veelgebruikte standard-readme-specificatie zijn het eens over de volgorde. Zet de snel te scannen onderdelen bovenaan: iemand die op je repo belandt, beslist binnen 20 seconden of hij verder leest.

Sectie Positie Doel
Titel + slogan Regel 1–2 # Project, gevolgd door één zin over wat het doet
Badges Regel 3–5 CI-status, npm-versie, licentie, dekking
Installatie Boven de vouw Eén commando dat iemand kan kopiëren
Gebruik Boven de vouw Het kleinste bruikbare fragment dat uitvoer oplevert
API / opties Midden Tabellen met vlaggen, configuratiesleutels of endpoints
Bijdragen Tegen het einde Link naar CONTRIBUTING.md, gedragscode, PR-conventies
Licentie Als laatste SPDX-identificatie plus link naar LICENSE

Badges die echt helpen

De URL’s van Shields.io volgen een voorspelbaar patroon: https://img.shields.io/badge/<label>-<message>-<color>.svg. Nuttige live badges wijzen naar buildstatus, pakketversie en downloadaantallen, geen ijdelheidsmetrieken. Vier badges zijn meestal genoeg; meer is ruis.

Veelvoorkomende README-fouten

  • Geen installatiecommando op regel 1 van Installatie. Lezers scannen naar npm install of pip install; verstop je het achter proza, dan vertrekken ze.
  • Schermafbeeldingen van 3 MB. Verklein naar 800 px breed en comprimeer; GitHub serveert ze toch wel, maar mobiele lezers betalen de bandbreedte.
  • Verouderde badges. Een rode CI-badge vertelt bezoekers dat het project stuk is. Repareer de CI of verwijder de badge.
  • Ontbrekende licentie. Zonder licentie is je code standaard “alle rechten voorbehouden” en kunnen bedrijven hem niet gebruiken.

Veelgestelde vragen

Ja. Afgeschermde codeblokken, opsommingslijsten en koppen in ATX-stijl (voorvoegsel #) worden zonder wijzigingen weergegeven op GitHub, GitLab en Bitbucket. Het installatiecommando wordt getagd als een bash-blok; het snelstartblok blijft ongetagd zodat je zelf de taal bepaalt.

Voor de meeste ecosystemen README.md. Gebruik .rst alleen als je een Python-pakket publiceert waarvan de documentatie op Read the Docs staat en je wilt dat Sphinx het bestand als landingspagina hergebruikt.

Wanneer je een repository-URL opgeeft, voegt de generator één statische licentiebadge toe (https://img.shields.io/badge/license-<type>-blue.svg). Voor live badges (buildstatus, versie, downloads) kopieer je een shields.io-URL-patroon en plak je het zelf in de uitvoer.

Nee. De README wordt samengesteld uit de formulierwaarden en er wordt niets opgeslagen. Sluit het tabblad en de gegevens verdwijnen.

Gerelateerde tools

Webpack-configuratiegenerator

Maak een webpack.config.js voor webpack 5 voor gewoon JavaScript, React of Vue: TypeScript, Babel, CSS of Sass, afbeeldingen, HtmlWebpackPlugin, een devserver en de npm install-regel.

OpenAPI-validator

Plak een OpenAPI- of Swagger-document in JSON of YAML en controleer de kernstructuur: versieveld, info-object en paths, met duidelijke fouten en waarschuwingen.

PHP-formatter

Voeg regelafbrekingen en een inspringing van 2 of 4 spaties toe aan een eenvoudige PHP-snippet. Controleer het resultaat: dit is geen PHP-parser of PSR-12-fixer.

CSS-loadergenerator

Maak een cirkelvormige spinner in pure CSS: stel de diameter, randdikte, accentkleur en rotatiesnelheid in, bekijk het live en kopieer de kant-en-klare CSS. Geen SVG, geen JavaScript.

ASCII-tabelreferentie

Volledige ASCII-tabel van 0 tot 127 met decimale, hexadecimale, octale en binaire waarden en HTML-numerieke referentienotatie, inclusief control codes zoals NUL, LF en DEL.

YAML naar JSON

Omzet de YAML-configuratie naar JSON voor tools en API's die alleen JSON ondersteunen. Handelt van ankers, samenvoegings sleutels en geneste structuren.

Tool beschikbaar in andere talen