diff --git a/README.md b/README.md index 1febc7d..2cba030 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,18 @@ Asjon è un chat bot creato usando l'[Hubot][hubot] framework. Asjon può: -- cercare immagini e video su internet -- cercare testi musicali su internet -- collegarsi al registro elettronico e al sito web dell'IIS Galilei di Crema -(se munito di credenziali), visualizzando l'agenda scolastica, i compiti e le circolari -- riportare il meteo per Crema -- ricordare nozioni o date arbitrarie -- visitare [9gag](http://9gag.com) -- e tante altre cose! +- cercare immagini e gif su internet +- cercare video di youtube +- riportare il meteo +- ricordare nozioni o date +- creare memes +- fare calcoli e risolvere problemi con wolfram|alpha +- inviare immagini di [RMS](https://en.wikipedia.org/wiki/Richard_Stallman) +- invitare persone in un gruppo di telegram +- dare informazioni sui propri contatti +- aprire [reverse shell](http://unix.stackexchange.com/q/46235) +- aggiornarsi ed eseguire test autonomamente +- e altro ancora Asjon è sviluppato in collaborazione con gli studenti della 5IA (2014/2015) dell'IIS Galileo Galilei di Crema. @@ -34,20 +38,34 @@ Asjon necessita di: - `node` e `npm` - `redis` se si vuole salvare la sua memoria in maniera persistente -- `phantomjs` per utilizzare il modulo agenda/compiti +- `telegram-cli` con supporto python per l'adapter di telegram ### Installazione -1. installare le dipendenze. Su arch linux: `pacman -S python2 nodejs phantomjs redis` -1. clonare questa repo -1. lanciare `npm install` (__Attenzione:__ usare `PYTHON=python2 npm install` su arch linux!) per installare tutte le dipendenze npm -1. se vuoi che Asjon conservi i ricordi tra una sessione e l'altra, avvia redis (su arch linux: `systemctl start redis`) -1. lanciare `bin/hubot` per testare il bot. Per usare le variabili d'ambiente usare -la sintassi di bash `VARIABILE=valore VAR2=valore2 bin/hubot`. +Si consiglia di usare di usare [nix](http://nixos.org/nix/) per gestire le dipendenze. +È presente un'espressione `nix.shell` nella root del progretto che può essere usata semplicemente +eseguendo + + $ nix-shell + +nella directory. Nella nuova shell installare asjon con + + $ npm install + ### Utilizzo -Puoi avviare asjon eseguendo +Puoi avviare asjon tramite `nix-shell` con + + $ nix-shell --arg mode \"run\" + +Altre `mode` possibili sono: + + * `runTg`: avvia asjon sull'adapter di telegram (è necessario fare il login al primo utilizzo) + * `test`: esegui i test d'integrità + * `shell` (default): apre una nix-shell + +Puoi anche avviare asjon manualmente eseguendo $ bin/hubot @@ -80,7 +98,7 @@ La [Scripting Guide](scripting-docs) di hubot è molto utile per imparare come f ### Hosting -Asjon può essere hostato come un qualsiasi Hubot, ma richiede phantomjs per alcune funzioni. +Asjon può essere hostato come un qualsiasi Hubot. Il ramo `master` di Asjon è sempre hostato online ed è accessibile tramite telegram all'username Asjon ROBOT.