Gör en README
förslag på en bra README
varje projekt är annorlunda, så överväga vilka av dessa avsnitt som gäller för din. De avsnitt som används i mallen är förslag på de flesta open source-projekt. Tänk också på att medan en README kan vara för lång och detaljerad, är för lång bättre än för kort. Om du tror att din README är för lång, överväga att använda en annan form av dokumentation snarare än att skära ut information.
Name
Välj ett självförklarande namn för ditt projekt.,
beskrivning
Låt folk veta vad ditt projekt kan göra specifikt. Ange sammanhang och Lägg till en länk till eventuella referens besökare kan vara obekant med. En lista över funktioner eller en Bakgrunds underavdelning kan också läggas till här. Om det finns alternativ till ditt projekt är detta ett bra ställe att lista differentierande faktorer.
märken
på vissa READMEs kan du se små bilder som förmedlar metadata, till exempel om alla tester passerar för projektet eller inte. Du kan använda sköldar för att lägga till några till din README. Många tjänster har också instruktioner för att lägga till ett märke.,
grafik
beroende på vad du gör kan det vara en bra idé att inkludera skärmdumpar eller till och med en video (du ser ofta Gif istället för faktiska videoklipp). Verktyg som ttygif kan hjälpa, men kolla in Asciinema för en mer sofistikerad metod.
Installation
inom ett visst ekosystem kan det finnas ett vanligt sätt att installera saker, till exempel att använda garn, NuGet eller Homebrew. Tänk dock på möjligheten att den som läser din README är en nybörjare och vill ha mer vägledning., Lista specifika steg hjälper till att ta bort tvetydighet och får människor att använda ditt projekt så snabbt som möjligt. Om det bara körs i ett visst sammanhang som en viss programmeringsspråk version eller operativsystem eller har beroenden som måste installeras manuellt, också lägga till ett krav underavsnitt.
användning
använd exempel frikostigt, och visa den förväntade produktionen om du kan. Det är bra att ha inline det minsta exemplet på användning som du kan visa, samtidigt som länkar till mer sofistikerade exempel om de är för långa för att rimligen inkludera i README.,
Support
berätta för folk var de kan gå till för hjälp. Det kan vara vilken kombination av en fråga tracker, ett chattrum, en e-postadress, etc.
färdplan
om du har idéer för utgåvor i framtiden är det en bra idé att lista dem i README.
bidragande
Ange om du är öppen för bidrag och vad dina krav är för att acceptera dem.
för personer som vill göra ändringar i ditt projekt är det bra att ha lite dokumentation om hur du kommer igång., Kanske finns det ett skript som de ska köra eller några miljövariabler som de behöver ställa in. Gör dessa steg explicit. Dessa instruktioner kan också vara användbara för ditt framtida jag.
Du kan också dokumentera kommandon för att länka koden eller köra tester. Dessa steg bidrar till att säkerställa hög kodkvalitet och minska sannolikheten för att ändringarna oavsiktligt bryta något. Att ha instruktioner för att köra test är särskilt användbart om det kräver extern installation, till exempel att starta en Selenserver för testning i en webbläsare.,
författare och bekräftelse
visa din uppskattning för dem som har bidragit till projektet.
licens
För open source-projekt, säg hur det är licensierat.
projektstatus
om du har slut på energi eller tid för ditt projekt, Lägg en anteckning högst upp i README som säger att utvecklingen har saktat ner eller slutat helt. Någon kan välja att gaffla ditt projekt eller volontär att gå in som en ansvarig eller ägare, så att ditt projekt kan fortsätta. Du kan också göra en uttrycklig begäran om underhållare.