Menü
c't Magazin

Der erste Eindruck zählt: README.md für GitHub verschönern

Ob man sich ein GitHub-Projekt genauer ansieht, hängt vom ersten Eindruck des Readme ab. Entwickler kommen mit einfachen Hilfsmitteln zu etwas Aufmerksamkeit.

Von
Drucken Kommentare lesen 1 Beitrag
Der erste Eindruck zählt: README.md für GitHub verschönern

13 Badges sind sicher zu viel des Guten – im Repository von shields.io sollen sie vor allem zeigen, was möglich ist.

Hat man ein Open-Source-Projekt öffentlich bei GitHub angelegt, bekommt man früher oder später Nachrichten von Wildfremden. Die Suchmaschinenoptimierung von GitHub macht es leicht – gibt man unter den "Topics", also der Schlagwortzeile ganz oben, ein paar passende Begriffe wie die verwendete Programmiersprache ein, ist man schnell unter den Top-Treffern bei Google und wird angeklickt. Jetzt gilt es, dem Besucher in wenigen Augenblicken den Eindruck zu vermitteln, dass es sich um ein gepflegtes und benutzbares Projekt handelt.

Ein beliebtes Mittel sind sogenannte Badges, also kleine Bildchen im Querformat, die eine knackige Information enthalten – zu finden in den Readmes fast aller erfolgreichen Projekte. Solche Badges bringen Farbe in die trockene Materie und das Projekt wirkt sofort lebendig. Die vermittelte Information kann statisch sein, wie die verwendete Lizenz, oder dynamisch generiert werden, wie die Anzahl der offenen Issues und erhaltenen Sternchen.

Durchgesetzt hat sich ein Layout mit abgerundeten Ecken. Links steht eine Beschreibung auf grauem Hintergrund, rechts die Information selbst. Zum Glück für den Entwickler muss man solche Badges nicht per Hand in der Bildbearbeitung erstellen und irgendwo hochladen. Stattdessen kann man auf einen Webdienst setzen und dessen URL in die Readme-Datei einbetten. Bewährt hat sich der kostenlose Dienst "shields.io", der sich aus Spenden finanziert und selbst als Open-Source-Projekt organisiert ist.

Immer mehr Wissen. Das digitale Abo für IT und Technik.

  • Zugriff auf alle Inhalte von heise+
  • exklusive Tests, Ratgeber & Hintergründe: unabhängig, kritisch fundiert
  • mit der Kompetenz von heise online, c't, iX, Technology Review, Mac & i, Make, c't Fotografie
  • einmal anmelden - alle Inhalte aller Fachredaktionen lesen - auf allen Geräten
  • erster Monat gratis, danach monatlich 9,95 €
  • jederzeit kündbar
GRATIS-Monat beginnen Jetzt GRATIS-Monat beginnen Mehr Informationen zu heise+
Anzeige