From c1f867f97ca64f398b5c94068eba6c2eab1af28d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1lint=20Bokros?= Date: Fri, 8 Dec 2017 12:00:51 +0100 Subject: [PATCH] Update readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f9b8c62..605c40f 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,19 @@ Run with `docker run -p 4242:4242 ` to bind the container's port to localhos ## Running locally -Open two terminals in the project root. +Create a new virtualenv, preferably with [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io). Install the +dependencies with `pip install tornado pyzmq transitions`. If using virtualenvwrapper, issue `add2virtualenv lib` from +the project root to add the local libraries to the virtualenv's PYTHONPATH. -Issue +To start the project issue ``` cd src/app/ -PYTHONPATH="../../lib/" python app.py +python app.py ``` -in one, and +in one terminal, and ``` cd src/components/ -PYTHONPATH="../../lib/" python event_handler_main.py +python event_handler_main.py ``` -in the other. +in another. Prepend the python commands with `PYTHONPATH="../../lib/"` if the folder weren't added to the PYTHONPATH +permanently.