Schrijf een README of changelog in minuten

Vul een kort formulier in en krijg een nette README.md met installatiestappen, gebruik, configuratie en licentie, of een CHANGELOG.md in het Keep a Changelog-formaat. Zie het resultaat terwijl je typt. Alles wordt in je browser geschreven en niets wat je typt wordt geüpload. Het is gratis.

Hoe je een README maakt, stap voor stap

1. Kies bovenaan README.md.
2. Voer onder Over het project de Projectnaam, een Samenvatting in één regel, een Beschrijving en de Functies en Vereisten in, een per regel.
3. Kies onder Installeren en gebruiken een Pakketbeheerder zoals npm, pip of Cargo, voeg de Repository-URL toe en schrijf je Gebruik. Kies de Gebruikstaal zodat de code goed wordt opgemaakt.
4. Voeg Instellingen- en Ontwikkelopdrachten toe als die van toepassing zijn.
5. Kies een Licentie en Auteursrechthebbende en zet het Inhoudsopgave, de Licentiebadge of de sectie Bijdragen aan als dat nodig is.
6. Druk op Markdown kopiëren of README.md downloaden.

Wat een goede README maakt

Zeg in één regel wat het project doet, laat dan zien hoe je het installeert en het kleinste voorbeeld dat werkt. Lezers beslissen in seconden of een project past, dus functies en vereisten komen daarna, gevolgd door instellingen, ontwikkelopdrachten, hoe je bijdraagt en de licentie. Secties die je leeg laat worden weggelaten.

Changelogs die mensen kunnen lezen

De changelog volgt Keep a Changelog: nieuwste release eerst, elk met een datum en zijn wijzigingen gegroepeerd als Toegevoegd, Gewijzigd, Verouderd, Verwijderd, Opgelost en Beveiliging. Houd bovenaan een sectie Ongepubliceerd voor wijzigingen die nog niet zijn uitgebracht. Met een repository-adres linkt elke versie naar de vergelijking met de vorige. Je kunt een oudere release met de hand toevoegen, of items bouwen uit commitberichten.

Tips

• Zet een werkende installatieopdracht en een kort gebruiksvoorbeeld bovenaan.
• Noem de licentie duidelijk zodat anderen weten hoe ze je code mogen gebruiken.
• Laat de beschrijving gaan over wat het project voor de lezer doet, niet hoe je het hebt gebouwd.
• Werk de changelog bij met elke release, niet pas aan het eind.

Gebruik de gitignore-generator en de env-voorbeeldgenerator om geheimen en buildbestanden uit een repository te houden.

Vragen

Kan ik beginnen vanuit mijn commitgeschiedenis?

Ja. Plak de uitvoer van git log --oneline onder Uit commitberichten. Commits geschreven als feat:, fix:, perf: enzovoort worden in de juiste groepen gesorteerd, en brekende wijzigingen met een uitroepteken worden gelabeld. Bewerk daarna de formulering; commitberichten zijn voor ontwikkelaars geschreven, changelogs voor gebruikers.

Voegt het de licentietekst toe?

Het voegt een sectie Licentie toe die de licentie noemt en naar een LICENSE-bestand verwijst. Zet de volledige licentietekst in dat bestand; de officiële pagina van de licentie heeft hem.

Waar komen de bestanden?

Downloaden slaat README.md of CHANGELOG.md op je apparaat op. Zet het in de hoofdmap van je repository en codehosts tonen het op de projectpagina.

Welke licenties kan ik kiezen?

MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, ISC, MPL 2.0, Unlicense of Alle rechten voorbehouden, of laat de sectie weg.