From 18f84abfb3450341bbaedfb080daedbb90845070 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <ste.pigozzi@gmail.com>
Date: Sun, 11 Oct 2020 16:05:48 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Improve=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 97 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 08f2b17..4cd2b68 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,107 @@ Semplice script per fare un dump delle lezioni registrate attualmente condivise
 
 - - - -
 
-### Requisiti per il funzionamento
+### Prerequisiti
 
-* BeautifulSoup come libreria per python
-* ffmpeg chiamato sul terminale
+* [ffmpeg](https://ffmpeg.org/download.html) presente nel PATH
+
+- - - -
+
+### Installazione
+
+Per installare aulavirtuale-dl:
+
+1. Clona (scarica) questo repository:
+   ```bash
+   git clone https://github.com/Gioo9le/aulavirtuale-dl
+   ```
+
+2. Entra nella directory che si è creata:
+   ```bash
+   cd aulavirtuale-dl
+   ```
+
+3. Crea e attiva un nuovo `venv`:
+   
+   - su Linux:
+     ```bash
+     python3 -m venv venv
+     source venv/bin/activate
+     ```
+  
+   - su Windows:
+     ```bat
+     py -m venv venv
+     venv\Scripts\activate.bat
+     ```
+
+4. Installa BeautifulSoup4 per il parsing di pagine web:
+   ```bash
+   pip install beautifulsoup4
+   ```
 
 - - - -
 
 ### Utilizzo
 
-Basta avviare lo script da terminale senza parametri o opzioni, l’elenco dei link alle lezioni e’ memorizzato su un dizionario all’interno del file, lo aggiornerò’ man mano che le lezioni verranno pubblicate, ma lo si può’ anche aggiornare in locale semplicemente aggiungendo una nuova voce al dizionario con come chiave la data della lezione e come valore il meetingId scritto alla fine del link che si apre quando si visualizza una lezione registrata 
+Per scaricare tutte le lezioni attualmente conosciute:
 
-> Es. https://davy04.edunova.it/playback/presentation/2.0/playback.html?meetingId=17d59e4eb742c498e605406fd441c1a2d7eb4bf0-1601628738707 -> MeetingId = 17d59e4eb742c498e605406fd441c1a2d7eb4bf0-1601628738707  
+1. Attiva il `venv` creato in precedenza:
+
+   - su Linux:
+     ```bash
+     source venv/bin/activate
+     ```
+     
+   - su Windows:
+     ```bat
+     venv\Scripts\activate.bat
+     ```
+
+2. Avvia lo script di download:
+   ```
+   python aulavirtuale-dl
+   ```
+  
+> Nota: il download e la combinazione delle lezioni potrebbe richiedere molto tempo!
+> Si consiglia di farlo nelle ore di inattività del computer.
+
+- - - -
+
+### Aggiornamento
+
+Per aggiornare `aulavirtuale-dl` all'ultima versione:
+
+1. Se hai modificato in precedenza dei file del progetto:
+   
+   - Per eliminare le tue modifiche:
+     ```
+     git stash
+     ```
+     
+   - Per mantenere le tue modifiche (e in seguito effettuare il merge con quelle remote):
+     ```
+     git add "*"
+     git commit
+     ```
+
+2. Scarica tutti i nuovi commit dal repository GitHub:
+  ```
+  git pull
+  ```
+
+- - - -
+
+### Aggiungere nuove lezioni
+
+I link a tutte le lezioni conosciute sono memorizzati in `aulavirtuale-dl.py`, nel dizionario `meetingsID` che
+ associa il nome del file che verrà creato all'meetingID di BBB.
+
+> ##### Come trovare il meetingID  
+> ```
+> https://davy04.edunova.it/playback/presentation/2.0/playback.html?meetingId=17d59e4eb742c498e605406fd441c1a2d7eb4bf0-1601628738707
+>                                                                             ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑↑ 
+> ```
+
+Esso sarà aggiornato man mano che le lezioni verranno pubblicate, ma lo si può anche aggiornare manualmente aggiungendo
+ nuove voci al dizionario.