Softonic

README-generator

Steg 1 / 4 README.md
Nästa

Tomma repositorier är ett dåligt första intryck. Fyll i projektnamn, en slogan på en rad, en lista med funktioner, installationskommandot, ett snabbstartsutdrag, författare och licens, så skapar den här generatorn en ren Markdown-README med en korrekt rubrikhierarki och kodblock med staket: de avsnitt GitHub renderar på ditt projekts sida. Kopiera den, spara den som README.md i roten av ditt repo och pusha. Avsnittsrubrikerna är skrivna på engelska, den närmast universella konventionen för README-filer med öppen källkod; din egen text visas exakt som du skriver den, på vilket språk som helst.

Så utformar du en README

  1. 1

    Lägg till grunderna

    Projektnamn, en valfri repository-URL och en slogan på en rad. Namnet blir `#`-titeln; sloganen blir citatet under den.

  2. 2

    Lista funktioner och en snabbstart

    En funktion per rad (var och en blir en punkt), plus ett kort snabbstartsutdrag som omsluts av ett kodblock med staket.

  3. 3

    Installation, licens och författare

    Installationskommandot hamnar i ett `bash`-kodblock under Installation; lägg till licensen (MIT, Apache-2.0…) och en valfri författarrad.

  4. 4

    Kopiera Markdown-koden

    Tryck på kopiera och klistra in utdatan som `README.md` i roten av ditt repo. Pusha så visas den renderade versionen på projektsidan.

Vad en bra README innehåller

GitHubs egen stilguide och den vitt använda standard-readme-specifikationen är överens om ordningen. Placera de snabbläsbara delarna högst upp, en människa som landar på ditt repo bestämmer på 20 sekunder om hen ska fortsätta läsa.

Avsnitt Position Syfte
Titel + slogan Rad 1–2 # Projekt följt av en mening om vad det gör
Märken Rad 3–5 CI-status, npm-version, licens, täckning
Installation Ovanför vikningen Ett enda kommando någon kan kopiera
Användning Ovanför vikningen Det minsta livskraftiga utdraget som producerar utdata
API / alternativ Mitten Tabeller med flaggor, konfigurationsnycklar eller endpoints
Bidra Nära slutet Länk till CONTRIBUTING.md, uppförandekod, PR-konventioner
Licens Sist SPDX-identifierare plus länk till LICENSE

Märken som faktiskt hjälper

Shields.io-URL:er följer ett förutsägbart mönster: https://img.shields.io/badge/<label>-<message>-<color>.svg. Användbara livemärken pekar mot byggstatus, paketversion och nedladdningssiffror, inte fåfängemått. Fyra märken räcker oftast; fler är brus.

Vanliga README-misstag

  • Inget installationskommando på rad 1 i Installation. Läsare skummar efter npm install eller pip install; göm det bakom prosa och de lämnar.
  • Skärmbilder som är 3 MB. Ändra storlek till 800 px bred och komprimera, GitHub serverar dem oavsett, men mobilläsare betalar bandbredden.
  • Föråldrade märken. Ett rött CI-märke berättar för besökare att projektet är trasigt. Antingen fixa CI eller ta bort märket.
  • Saknad licens. Utan en licens är din kod “all rights reserved” som standard och företag kan inte använda den.

Vanliga frågor

Ja. Kodblock med staket, punktlistor och rubriker i ATX-stil (#-prefix) renderas på GitHub, GitLab och Bitbucket utan ändringar. Installationskommandot taggas som ett bash-block; snabbstartsblocket lämnas otaggat så att du själv anger språket.

För de flesta ekosystem, README.md. Använd .rst endast om du publicerar ett Python-paket vars dokumentation ligger på Read the Docs och du vill att Sphinx ska återanvända filen som landningssida.

När du anger en repository-URL lägger generatorn till ett enda statiskt licensmärke (https://img.shields.io/badge/license-<type>-blue.svg). För livemärken (byggstatus, version, nedladdningar) kopierar du ett shields.io-URL-mönster och klistrar in det i utdatan själv.

Nej. README:n sätts samman från formulärvärdena och inget sparas. Stäng fliken så är datan borta.

Relaterade verktyg

Webpack-konfigurationsgenerator

Skapa en webpack.config.js för webpack 5 med vanlig JavaScript, React eller Vue: TypeScript, Babel, CSS eller Sass, bilder, HtmlWebpackPlugin, en utvecklingsserver och raden för npm install.

Protocol Buffers-avkodare

Avkoda Protobuf-byte lokalt från hex, Base64, Base64URL, text eller fil, granska fälttolkningar och exportera en privat rapport.

XSD-validerare

Validera ett XML-dokument mot ett XSD-schema och rapportera element- och typavvikelser med exakta radnummer.

YAML till JSON

Omvandla YAML-konfiguration till JSON för verktyg och API:er som bara accepterar JSON. Hanterar ankare, merge-nycklar och nästlade strukturer.

XML-formaterare

Snygga till XML-dokument med konsekvent indrag och fånga formfel med exakta radnummer.

XML till JSON

Omvandla XML-dokument till ren JSON, med bevarade attribut, textnoder och arrayer där det behövs. Tre stilar: kompakt, Badgerfish eller literal.

Verktyget finns på andra språk