GitHub: come modificare la presentazione di un repository con README.md

In questo breve articolo vedremo come modificare il file README.md, che permette di fornire una panoramica del repository GitHub.

Quando pubblichiamo un repository, potremmo avere la necessità di presentare il progetto o l’applicativo. Questa presentazione può essere realizzata attraverso il file README.md, che viene visualizzato nella pagina principale del repository.

Dopo aver creato e pubblicato il file README.md, può capitare di dover apportare delle modifiche al suo contenuto.

Per modificare il file, è sufficiente posizionarsi nella sezione del README.md e, nella parte superiore destra, fare clic sull’icona della matita, come mostrato nella Figura 1.

Figura 1 – Il pulsante della matita per la modifica

Dopo aver fatto clic sull’icona della matita, il file README.md verrà aperto in modalità di modifica, come mostrato nella Figura 2.

Figura 2 – Il file in modalità editing

Dopo aver modificato la presentazione, tramite il pulsante “Preview” possiamo visualizzare l’anteprima e verificare se le modifiche sono di nostro gradimento oppure se sono necessarie ulteriori modifiche.

Una volta verificato che il risultato è corretto, non resta che effettuare il commit, ossia confermare e salvare le modifiche apportate.

Nella parte superiore destra della pagina troviamo un pulsante di colore verde con la dicitura “Commit Changes…” (Figura 3), tramite il quale possiamo confermare le modifiche.

Figura 3 – Il pulsante per confermare le modifiche

Facciamo clic sul pulsante “Commit changes…” per confermare le modifiche. Verrà visualizzata una finestra in primo piano (Figura 4) nella quale possiamo specificare un messaggio che descriva le modifiche effettuate.

Possiamo mantenere il messaggio proposto automaticamente da GitHub oppure modificarlo e integrarlo in base alle nostre esigenze.

Figura 4 – Il messaggio di conferma con la possibilità di fornire informazioni sulla modifica

Dopo aver verificato il testo modificato e aver controllato l’anteprima, facciamo clic sul pulsante “Commit Changes” per confermare definitivamente le modifiche.

A questo punto, le modifiche verranno salvate e il file README.md sarà aggiornato.

Conclusioni

In questo articolo abbiamo visto uno dei tanti modi per modificare il file README.md, utilizzato per fornire informazioni e una presentazione del repository.

La semplicità e l’intuitività di GitHub permettono di gestire e aggiornare facilmente i propri progetti, anche attraverso strumenti accessibili direttamente dall’interfaccia web.