From 28fcd50d0fdba56dc810ff22080996fba308bdf0 Mon Sep 17 00:00:00 2001
From: Ruben van de Ven <git@rubenvandeven.com>
Date: Thu, 7 Mar 2019 08:36:05 +0100
Subject: [PATCH] Extend README, config for Central Command and fix
 requirements.server.txt

---
 README.md               | 43 ++++++++++++++++++++++++++++++++++++++++-
 client_config.yml       |  6 +++---
 requirements.server.txt |  3 +++
 3 files changed, 48 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a3dc234..2e1bfae 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
 # Hugvey / Pillow Talk
 
+Panpoticon
+: Fancy nickname for the web interface that allows altering the story and running the individual Hugveys
+Voice
+: Lyrebird voice syntehsis API wrapper. Set the oAuth token using a token generated [here](http://hugvey.rubenvandeven.com/oauth.php)
+Client
+: Individual Hugveys that stream their mic output and play audiofiles trough the Panopticon. Communication with the server is done through zmq
+: Connect with them trough hugvey1.local etc (1-25).
+Central Command/server
+: One server to rule them all. Start individual threads/subprocesses for the individual Hugveys. The Panopticon is started when starting the server.
+
+
 ## Server
 
 Run the server: `python hugvey_server.py --config server_config.yml`
@@ -15,4 +26,34 @@ To run it: `python hugvey_client.py -c client_config.yml`
 
 ## Development
 
-The Panopticon uses gulp to compile SASS into CSS, and to set up browser-sync for css & js. For now, no js user facing dependencies are managed trough node/npm.
\ No newline at end of file
+The Panopticon uses gulp to compile SASS into CSS, and to set up browser-sync for css & js. For now, no js user facing dependencies are managed trough node/npm.
+
+## Installation
+
+create and load Python virtualenv
+
+```bash
+virtualenv -p python3 --system-site-packages venv
+source venv/bin/activate
+```
+
+Install requirements
+
+```bash
+apt install libasound-dev python3-pyaudio git-lfs
+pip install -r requirements.server.txt
+pip install -r requirements.txt
+```
+
+Install soft requirements (These are hard requirements for the clients!)
+
+```
+apt install sox rsync
+```
+
+Don't forget to init git submodules
+
+```
+git submodule init
+git sumodule update
+```
diff --git a/client_config.yml b/client_config.yml
index 685182a..b992616 100644
--- a/client_config.yml
+++ b/client_config.yml
@@ -1,12 +1,12 @@
 events:
-    cmd_address: "tcp://127.0.0.1:5555"
-    publish_address: "tcp://127.0.0.1:5556"
+    cmd_address: "tcp://hugveycmd.local:5555"
+    publish_address: "tcp://hugveycmd.local:5556"
 voice:
     input_rate: 44100
     target_rate: 16000
     port: 4444
     input_name: null
-    file_address: "http://192.168.178.185:8888"
+    file_address: "http://hugveycmd.local:8888"
     play_device: null
     play_volume: 80
 
diff --git a/requirements.server.txt b/requirements.server.txt
index c654d26..4a80a15 100644
--- a/requirements.server.txt
+++ b/requirements.server.txt
@@ -4,3 +4,6 @@ coloredlogs
 pyyaml
 google-cloud-speech
 requests-threads
+fabric
+cutelog
+tornado