From 152e70d0a34004d87b3694a561b2869400a1cce0 Mon Sep 17 00:00:00 2001 From: Alberto Defendi Date: Sun, 6 Oct 2024 09:11:53 +0200 Subject: [PATCH] Update: Instructions for tutors. --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c3eba5d..bf436f0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,53 @@ Questo sito è realizzato in Astro e serve come supporto per il tutorato di matematica del corso di laurea in Matematica dell'Università di Pisa. -## Utilizzo + +## Per i tutors + +### Accedere a Gitea + +Collegati a [Gitea](https://git.phc.dm.unipi.it/) e clicca sul tasto Sign in. Nella finestra clicca su +Sign in With Google, e successivamente scrivi il tuo indirizzo email di ateneo +(ad esempio, nome.cognome@studenti.unipi.it), poi procedi con l'usuale login per i servizi di Ateneo. + +### Editare file + +Per potere modificare i file, è necessario chiedere ai Macchinisti di aggiornare +i permessi del proprio account, passando in PHC o mandando una mail. + +Entra nel [repository](https://git.phc.dm.unipi.it/phc/tutorato) e raggiungi la +cartella tutorato/src/pages/archivio/[Anno corrente]. Qui troverai il file +relativo al tuo tutorato (o se non esiste, chiedi ai macchinisti), ad esempio +quello relativo al corso di aritmetica è "aritmetica.md". +Cliccando sul file è possibile aprire l'editor di testo cliccando sulla matita +in alto a destra (se tale icona non risulta cliccabile, contatta i macchinisti). + +#### Scrivere in Latex + +Il file del tutorato è in formato Markdown ([Guida alla sintassi Markdown](https://www.markdownguide.org/basic-syntax/)), +ed è possibile scrivere in LaTeX tramite KaTeX, il quale supporta molti degli +usuali environments di LaTeX come, ad esempio, $ $ oppure $$ $$ oppure \[ \]. +Per famigliarizzarti con scrivere LaTeX in Markdown, vedi la pagina [esempio](https://git.phc.dm.unipi.it/phc/tutorato/src/branch/main/src/pages/archivio/2024-2025/esempio.md) +e [la lista dei simboli supportati da KaTeX](https://katex.org/docs/support_table). + +#### Caricare files + +È anche possibile includere link di files nella pagina, spostandosi nella cartella +"public/materiale/" e poi cliccando sul menu a tendina "add file". +A questo punto puoi aggiungere un link alla pagina come + +``` +Tutorato del [13 ottobre 2023](/materiale/TutoratoAnalisi13102023.pdf). +``` + +### Editing da locale + +È anche possibile editare i file da locale con il proprio editor clonando il repository +tramite git e facendo push/pull degli aggiornamenti. Per interagire con Gitea in +questo modo, la configurazione è analoga a quella di altri servizi come Github +o Gitlab. + +## Sviluppare Per sviluppare in locale è necessario avere installato Bun o NodeJS