2015-09-07 6 views
8

Was sind die wichtigsten Unterschiede zwischen Funktionalität Github Wiki und Readme sind,Was sind die wichtigsten Unterschiede zwischen Funktionalität Github Wiki und Readme sind,

diejenigen Fragen, die ausführlich sowohl readme und Wikis verwendet haben. So können wir besser entscheiden, was wir für die Ausgabe von verbalen Informationen verwenden. Dies würde auf Ihrer Antwort basieren. Vielen Dank.

Als Beispiele haben einige verwendet Wikis -

http://github.com/mbostock/d3/wiki
http://github.com/ParticleCore/Particle/wiki/Features

und einige Leute haben verwendet readmes -

http://gist.github.com/atcuno/3425484ac5cce5298932

keinen besseren Ort zu fragen? - meta.stackexchange.com/questions/157888/what-site-is-good-for-github-questions

+1

** ** Readme meist Bedeutet wichtiger Text, der in Bezug auf das Programm oder die Software gelesen werden sollte oder einfach eine Zusammenfassung davon enthält. Während ** Wiki ** ist eher wie eine Dokumentation oder ein Handbuch zu dieser Software. So kann eine ** Liesmich ** Dokumentation enthalten oder nicht enthalten, es kann auch zu persönlichen Vorlieben kommen. In diesem Sinne ist dies nicht wirklich eine Programmierfrage. –

+0

Die Readme und Wikis werden für die gleichen Zwecke (Bereitstellung von Informationen) verwendet, wie in den Beispielen gezeigt. Ich frage hauptsächlich nach Funktionalität – ambw

Antwort

5

Im Gespräch über ein Projekt-Repository:

  • Readme.md ist die Verpackung
  • wiki pages für Entwicklung/Autoren Dokumentation gemacht
  • gh-pages Zweig Hosts Benutzerdokumentation
+0

Ich habe mich gerade entschieden mit Wikis zu gehen, wie die meisten sie verwenden, also haben Wikis wahrscheinlich mehr Funktionalität (Formatierung, Graphen, etc.), ich werde meine Antwort schließlich finden .... – ambw

3

Beide Readme & Wiki haben keine Funktion, außer für die Bereitstellung von Informationen. Github empfiehlt Ihnen, eine README.md zu erstellen, um eine kurze Zusammenfassung & Nutzung Ihres Repository anzuzeigen, während das Wiki ist völlig optional.

+0

was ich meine ist Formatierung Optionen, Links, Grafiken und alles, was sie sonst tun, etc. (das ist, was ich mit 'Funktionalität' - nicht sicher, was ein besseres Wort zu verwenden) – ambw