2015-09-07 11 views
8

Quali sono le principali differenze tra funzionalità Github Wiki e Leggimi,Quali sono le principali differenze tra funzionalità Github Wiki e Leggimi,

domandato quelli che hanno utilizzato sia readme e wiki ampiamente. In modo che possiamo decidere meglio quale usare allo scopo di produrre informazioni verbali. Questo si baserebbe sulla tua risposta. Grazie.

Come esempi, alcuni hanno usato i wiki -

README

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

e alcune persone hanno usato -

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

posto migliore per chiedere? - meta.stackexchange.com/questions/157888/what-site-is-good-for-github-questions

+1

** ** Leggimi per lo più significa testo importante che dovrebbe essere letto per quanto riguarda il programma o il software, o semplicemente contiene un riassunto di esso. Mentre ** Wiki ** è più simile a una documentazione o manuale su quel software. Quindi un ** Leggimi ** può contenere o meno documentazione, può anche ridursi alle preferenze personali. Con questo in mente, questa non è davvero una domanda di programmazione. –

+0

i readme e i wiki vengono utilizzati per gli stessi scopi (fornire informazioni) come mostrato negli esempi. Im principalmente chiedendo funzionalità – ambw

risposta

5

Parlare di un repository del progetto:

  • Readme.md è il packaging
  • wiki pages è fatto per lo sviluppo/collaboratori documentazione
  • gh-pages host filiali utente documentazione
+0

ho appena deciso andare con i wiki come la maggior parte li usa, quindi i wiki probabilmente hanno più funzionalità (formattazione, grafici, ecc.), alla fine troverò la mia risposta .... – ambw

3

Entrambi i file readme & non hanno alcuna funzione, tranne che per fornire informazioni. Github consiglia di creare un README.md per visualizzare un breve sommario dell'uso del repository, &, mentre il Wiki è totalmente facoltativo.

+0

ciò che intendo è la formattazione di opzioni, collegamenti, grafici e tutto ciò che fanno, ecc. (questo è quello che intendo per "funzionalità" - non sono sicuro che cosa è una parola migliore da usare) – ambw

Problemi correlati