search

LernMoment / DailyGitHub

Lass uns gemeinsam professionell Software entwickeln auf GitHub. Täglich!
www.lernmoment.de
Creative Commons Zero v1.0 Universal
5 stars 1 forks source link

Wichtige Elemente für das Projekt README.md #36

Closed suchja closed 8 years ago

suchja commented 8 years ago

Die meisten Projekte auf GitHub haben ein README. Das ist auch gut so, weil jeder sich so einfach über das Projekt informieren kann. Welche Aspekte sind jedoch besonders wichtig?

suchja commented 8 years ago

https://www.lullabot.com/articles/managing-projects-with-github Gibt einige gute Punkte. Aus meiner Sicht die wichtigsten sind:

  1. kurze Projektbeschreibung
  2. erklären wie das Projekt gebaut werden kann (Entwicklungsumgebung)
  3. Beschreibung der gewünschten Zusammenarbeit
  4. Links zu weiteren Informationen
suchja commented 8 years ago

Ein Beispiel für ein super README.md ist zum Beispiel dotnet/corefx.