Questo modello di relazione d'esame di Didattica dell'Informatica è stato utilizzato come base da Daniele Tentoni. Può essere modificato come meglio si crede seguendo la licenza GPL.
Puoi vedere il risultato pubblicato qui.
Tabella dei contenuti:
Cerca in tutto il repository ogni riferimento a questo repository (cs-teaching-exam-template
) e correggilo con i riferimenti corretti al tuo nuovo repository (li trovi nei link dei status badge in questo file e nel file dep5 di REUSE).
Installa Renovate se vuoi sfruttarlo ed eventualmente usa la tua configurazione nel file .github/renovate.json
. Altrimenti, se non vuoi usare renovate, puoi cancellarlo.
Prima di effettuare il deploy su Github Pages, devi abilitarle dalle impostazioni del repository. Dopodiché, funziona senza alcun altro intervento.
Compila la relazione in Markdown utilizzando pandoc:
sudo apt install pandoc
curl 'https://raw.githubusercontent.com/ryangrose/easy-pandoc-templates/master/html/elegant_bootstrap_menu.html' > .pandoc/templates/elegant_bootstrap_menu.html
mkdir dist
pandoc esame/esame.md --from=markdown --to=html --output=dist/index.html --toc --template=elegant_bootstrap_menu.html --data-dir=.pandoc
Ogni volta che verrà effettuata una push sul branch principale verrà effettuato un deploy tutto in automatico.
Il materiale di questo repository è protetto, salvo se diversamente specificato, da licenza GPL 3.0 disponibile qui.
La relazione d'esame d'esempio proposta in esame/esame.md
è la stessa proposta dal prof. Michael Lodi per il relativo corso qui di pubblico dominio.
Reuse è un progetto che aiuta a mantenere le license software e renderle chiare e accessibili per umani e computers. Puoi ottenere maggiori informazioni sul sito ufficiale del progetto.
Ogni volta che verrà effettuata una push o verrà aperta una pull request verso il branch principale, verrà controllato se ogni file dentro al progetto è correttamente licenziato o meno. Per ulteriori informazioni a riguardo, leggi qui.
In ogni momento puoi controllare che il tuo lavoro sia conforme alle specifiche tramite l'uso del tool dedicato:
reuse lint
Il tool permette anche di aggiungere gli headers specifici per ogni tipo di file tramite dei comandi appositi:
reuse addheader --copyright=<your_name> --license=<desired_license> file
Puoi contribuire a questo repository template aprendo issues o pull requests.
Come contributi interessanti da portare avanti ci sarebbero quello di creare un Makefile per semplificare le operazioni più ripetitive oppure quello di aggiungere il supporto almeno per Latex nel caso qualche altro studente ne avesse bisogno. Io ho usato il Markdown.
E ovviamente traducendo in Inglese questo file.