readme

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7cec4ac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# live cortex
+
+Cortex relay chain for doing IPC with Pix2Pix running on a faraway server.
+
+## Requirements
+
+* Zeromq (apt/brew install zeromq)
+* node 8.x
+* `npm install`
+* python 3.x
+* `pip install -R requirements.txt`
+
+## Four components
+
+### ZeroRPC API wrapper
+
+To be inserted into Pix2pix or another dynamic image generation script.  Should accept changes in parameters, and send a continuous stream of images.
+
+### Local websocket relay
+
+For the time being it just seems easier to have a websocket relay that can forward ZeroRPC traffic to our remote server, and keep running even if we aren't running pix2pix.  Think of this as the local cortex daemon.  In the future it will have other modules for running scripts from these different libraries.
+
+### Remote websocket relay / app server
+
+Receives a stream of images from the local relay and forwards them on to the client.  Forwards client's API changes.  Possibly stores presets and renders, records usage, etc.
+
+### Web frontend
+
+Webpage that displays the latest images from pix2pix that have been streamed in, and also has a bunch of sliders to control parameters and things.
+