/ExampleRepositories

Scopo di Questo Repository

Lo scopo di questo repository è quello di:

  • Standardizzare e Comunicare le modalità di condivisione degli appunti, all'interno dei repository relativi agli insegnamenti del corso LINTINF dell'Universita degli Studi di Parma (UniPr).
  • Facilitare gli studenti della LINTINF nella condivisione degli appunti.

Struttura del Repository

Root
 ├-Nome o Alias dello studente
      ├-DeliveryNote.md
      ├-License.md
      ├-Appunti
            ├- File dello studente.*

Spiegazione della struttura

Nella Root, ovvero nella posizione iniziale della repository, è presente una cartella "Nome o Alias dello studente". Questa cartella, che prende il nome dello studente o eventualmente un alias, conterra diversi file al suo interno:

  • DeliveryNote.md
    Il file "DeliveryNote.md", è un file di tipo markdown contenente una sorta di "Bolla d'Accompagnamento" degli appunti. In esso vi sono descritte varie informazioni relative agli appunti. Vedremo, in una sezione ad esso dedicata, il perchè di questo file e il com'è strutturato.
  • Appunti
    Nella cartella "Appunti", andranno messi i vostri appunti.

Che Tipo di Appunti Posso Caricare? e in che Formato?

Sebbene siano preferibili degli appunti scritti in formato digitale (Markdown, LaTex, PDF-No-Scan, ed etc), non vi sono particolari vincoli.
È infatti possibile caricare anche file PDF contenenti le pagine dei vostri appunti scannerizzati.
Questo perchè, anche se digiralizzati in un secondo momento, potrebbero rappresentare uno spunto per i vostri futuri colleghi.
L'unico vincolo che poniamo è l'utilizzo di formati leggibili da qualunque Sistema Operativo...
"Si, mi sto riferendo proprio a voi utenti Mac ;)"

DeliveryNote

Considerate questo file come se fosse una sorta di "Biglietto da Visita" dei vostri appunti.
Il suo scopo principale è quindi quello di dare informazioni rapide ai vostri colleghi, senza che siano obbligati ad aprire ogni singolo file.
Potete variare la sua struttura, in base alla tipologia di appunti. È importante però che rispettiate la sua forma base:

Nome o Alias Dello Studente: [Place Holder]
Tipologia di Appunti: [Scritti in digitale/ Scritti a mano e digitalizzati/ Misti]
//Se il corso è diviso in moduli
Moduli Trattati:
- Modulo 1
- Modulo 2
//Da qui in poi potete inserire qualunque informazione ritenitate necessaria.

Licenza

Avrete notato la presenza del file LICENSE.md.
Questo file contiene la Licenza dei vostri appunti.
Data la natura di questo progetto abbiamo deciso di utilizzare la licenza Attribution-NonCommercial-ShareAlike 4.0 International anche detta CC BY-NC-SA 4.0.
Trovate al seguente link, le informazioni relative a questa licenza: Link alla pagina della licenza.
La licenza serve per garantire che:

  • Vengano rispettati tutti crediti relativi ai rispettivi autori,
  • Non vengano utilizzati gli appunti a scopo commerciale.