[UPDATE] Aggiornato README.md in maniera sostanziosa

README.md

@@ -13,14 +13,117 @@
 
 ## Idea e scopo
 
-L'idea e lo scopo che ci alla base del servizio sono molto semplici: *fornire con una maggiore efficenza i menù agli studenti universitari, e soprattutto, rendere più accessibile l'accesso a quest'ultimi,* utilizzando una piattaforma come Telegram che è in grado di mettere in simbiosi questi due aspetti.
+L'idea e lo scopo che ci alla base del servizio sono molto semplici: *fornire con una maggiore efficienza i menù agli studenti universitari, e soprattutto, rendere più accessibile l'accesso a quest'ultimi,* utilizzando una piattaforma come Telegram che è in grado di mettere in simbiosi questi due aspetti.
+
 Fondamentalmente i menù universitari dell'ERSU di Camerino, vengono **esclusivamente** distribuiti mediante il sito ufficiale di quest'ultimo attraverso dei semplici file PDF e quindi abbiamo pensato di andare a rendere il servizio più *usufruibile* e *istantaneo*.
 
+## Caratteristiche
+
+*Look at the menu of the day, but do it with style*
+
+Di seguito le principali caratteristiche di **Unicam Eat!**:
+* Ottenere il menù del giorno, o di un giorno qualsiasi della settimana
+* Piattaforma basata su un software solido e affidabile
+* Possibilità di ricevere notifiche per il menù del giorno
+* Controllare prezzi, orari e molto altro grazie a un semplice click
+* Condividere il menù del giorno
+* Servizio dinamico ed elegante
+
 ## Struttura di Unicam Eat!
 
-Unicam Eat! come già affermato in precedenza è un bot Telegram. Questa piattafroma di messaggistica, infatti, mette a dispozione delle API che gli sviluppatori possono usufruire per andare a interfacciarsi con Telegram stesso. Il framework adoperato in questo caso è stato **Telepot**.
+Unicam Eat! come già affermato in precedenza è un bot Telegram. Questa piattaforma di messaggistica, infatti, mette a disposizione delle API che gli sviluppatori possono usufruire per andare a interfacciarsi con Telegram stesso. Il framework adoperato in questo caso è stato **Telepot**.
+
+### Gli elementi cardini del progetto
+
+Il core del progetto sta nell'andare a scaricare, attraverso delle request, i file PDF contenenti il menù richiesto e convertirli, grazie all'aiuto di **PDFMiner**, in semplici file di testo con i quali è possibile lavorare in maniera decisamente più semplice.
+
+```python
+def convert_in_txt(fname, pages = None):
+    """
+    Convert a .PDF file in a .txt file
+    """
+    if not pages:
+        pagenums = set()
+    else:
+        pagenums = set(pages)
+
+    output = StringIO()
+    manager = PDFResourceManager()
+    converter = TextConverter(manager, output, laparams = LAParams())
+    interpreter = PDFPageInterpreter(manager, converter)
+
+    infile = open(pdfDir + fname, 'rb')
+    for page in PDFPage.get_pages(infile, pagenums):
+        interpreter.process_page(page)
+    infile.close()
+    converter.close()
+    text = output.getvalue()
+    output.close()
+
+    textFilename = txtDir + "converted.txt"
+    textFile = open(textFilename, "w")
+    textFile.write(text)
+    textFile.close()
+```
+### Algoritmo di sorting
+
+Una volta effettuata la conversione, e quindi ottenuto il file di testo desiderato, si passa alla fase più delicata dell'intero processo, ovvero, andare a riordinare in maniera più affidabile possibile il menù del giorno seguendo le linee guida del PDF originale.
+
+Questa parte del software viene gestita in maniera davvero dettagliata e meticolosa per evitare eventuali problemi di qualsiasi genere. E possibile accedere a questa parte del codice consultando la funzione *advanced_read_txt()*.
+
+```python
+def advanced_read_txt(canteen, day, launch_or_dinner = "Pranzo"):
+    """
+    Format the messagge of the selected menu
+    """
+    txtName = txtDir + str(canteen) + "_" +  str(day) + ".pdf.txt"
+
+    # Convert in the right day and the right canteen, just for good appaerence
+    msg_menu = "🗓 - *{}* - *{}* - *{}*\n\n".format(clean_canteen(canteen), clean_day(day), launch_or_dinner)
+
+    # Getting ready to work
+    my_file = open(txtName, "r")
+    out = my_file.readlines()
+    my_file.close()
+
+    # Divides by sections the .txt
+    my_char = '\n'.encode("unicode_escape").decode("utf-8")
+    secs = []
+    current_sec = []
+
+    ...
+```
+
+### Invio del menù attraverso Telegram
+
+Una volta completate le prime due fasi si può passare alla fase finale cioè, sostanzialmente, l'invio del messaggio contenente il menù mediante Telegram. 
+
+Come già affermato in precedenza, grazie all'uso di **Telepot**, possiamo utilizzare le API messe a disposizione da Telegram e quindi andare ad usufruire una serie davvero molto ampia di *features* che vanno a costituire la struttura stessa del bot.
+
+```python
+try:
+    # Start working
+    bot = telepot.Bot(TOKEN)
+
+    # Checking if some messages has been sent to the bot
+    updates = bot.getUpdates()
+    if updates:
+        last_update_id = updates[-1]['update_id']
+        bot.getUpdates(offset = last_update_id + 1)
+
+    # Starting message_loop
+    bot.message_loop({'chat': handle,
+                      'callback_query': on_callback_query})
+
+    print("Da grandi poteri derivano grandi responsabilità")
+
+    # Notification system
+    while(1):
+        update()
+finally:
+    os.unlink(pidfile)
+```
 
-**Il core del progetto** sta nell'andare a scaricare, attraverso delle request, i file PDF contenenti il menù e convertirli, grazie all'aiuto di PDFMiner, in semplici file di testo con i quali è possibile lavorare in maniera decisamente più semplice.
 
 ## Installazione