summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSanto Cariotti <sancn@live.com>2017-07-22 08:30:24 +0200
committerSanto Cariotti <sancn@live.com>2017-07-22 08:30:24 +0200
commit78fbe77fb8deb38805a3f7c729ad4e549dcb7035 (patch)
tree51d638646420012b464edab76e3e3e627d528ba6
parent01f0aea1a4f74f83a41766197d3ad3c14a4d9c9f (diff)
edit doc
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index fc674ca..8b37178 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,13 @@ 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.
+Prima di poter utilizzare Stout, bisogna installare Python3, Flask e Redis:
+```bash
+sudo apt install python3
+sudo pip install Flask
+sudo pip install redis
+```
+
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
@@ -13,6 +20,12 @@ cd lib
FLASK_APP=web.py flask run --port=8080
```
+Il programma da terminale si trova sempre nella cartella lib:
+```bash
+cd lib
+python3 app.py
+```
+
Un esempio di funzionamento del programma:
```bash
> (🍺 ) (santo) info add
@@ -33,5 +46,5 @@ Ok
> (🍺 ) (santo) get todo
| 0 | Postare tutto su Sciax2 nella sezione Progetti Rilasciati
| 1 | Andare a comprare una RedBull
-> (🍺 ) (santo)
+> (🍺 ) (santo)
```