From 84f3b829c634dccfca61baaf670f11c4cfd4092c Mon Sep 17 00:00:00 2001 From: Santo Cariotti Date: Sat, 22 Jul 2017 08:18:11 +0200 Subject: added doc 2 --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7e4ffd7..fc674ca 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ ![logo](logo_stout.png) + +> Stout è distribuito sotto licenza MIT e pertanto è possibile farne il fork, modificarlo e distribuirlo nuovamente. +La lista dei comandi è disponibile su https://github.com/dcariotti/Stout. +Scrivere info [cmd] per avere più informazioni su un comando. + +Stout è un software che tramite linea di comando, e seguendo degli appositi comandi, permette di modificare la lista dei todo (cose da fare) ed eliminarli una volta fatti. + +Il software dispone di un client per il web in modo da visualizzare la lista dei todo in modo più comodo. _Necessita dell'installazione del microframework Flask_. Per avviarlo: + +```bash +cd lib +FLASK_APP=web.py flask run --port=8080 +``` + +Un esempio di funzionamento del programma: +```bash +> (🍺 ) (santo) info add +Inserisce un nuovo todo: ogni carattere dopo add sarà considerato tale +> (🍺 ) (santo) get ctodo +2 +> (🍺 ) (santo) get todo +| 0 | Finire la documentazione e poi inserirla su GitHub +| 1 | Postare tutto su Sciax2 nella sezione Progetti Rilasciati +> (🍺 ) (santo) add Andare a comprare una RedBull +Ok +> (🍺 ) (santo) get todo +| 0 | Finire la documentazione e poi inserirla su GitHub +| 1 | Postare tutto su Sciax2 nella sezione Progetti Rilasciati +| 2 | Andare a comprare una RedBull +> (🍺 ) (santo) del 0 +Ok +> (🍺 ) (santo) get todo +| 0 | Postare tutto su Sciax2 nella sezione Progetti Rilasciati +| 1 | Andare a comprare una RedBull +> (🍺 ) (santo) +``` -- cgit v1.2.3-18-g5258