luzzetti / git-and-github

Appunti relativi al corso Udemy relativo a Git e GitHub

Solitamente, nel README, scriviamo le informazioni fondamentali relative al repository, ad esempio:

• Cosa fa il progetto
• Come lanciarlo
• Cosa vale la pena sapere
• Come mantenerlo
• Ecc...

Fondamentalmente, le informazioni fondamentali per gli utenti che arrivano su un progetto per la prima volta.

Nel contesto di GitHub, lo mostrerà automaticamente nella pagina principale, PURCHE' SIA SCRITTO IN CAPSLOCK, E SI TROVI NELLA ROOT DI PROGETTO.

I file Readme, come visibile dall'estensione particolare, ossia ".md", sono dei file "Markdown". I file Markdown sono file che vengono automaticamente convertiti (renderizzati) in HTML (Markup), senza bisogno di saper scrivere in HTML.

Ovviamente sono meno flessibili dell'HTML, offrono minori possibilità, ma la sintassi è semplice da usare, e si trovano spesso in giro per il web. (Ad esempio nei forum, tipo reddit. O se non erro, nelle wiki)

è comodo conoscerli, e conoscere almeno la sintassi di base per poter formattare semi-decentemente un documento.

Tool per la scrittura (Esistono anche svariati plugin): https://markdown-it.github.io/

Guida un po' più approfondita: https://informaticabrutta.it/markdown-guida/