diff --git a/README.md b/README.md index 68d3ed1df62936dc4bc7a0491017ba2b88d65ef2..bba44c1958042622214e09c02d453bc7fca45995 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,12 @@ The web application for the Hodor Project ## Quickstart * Clone the repo using `git clone https://git.amrita.edu/hodorsec/hodor-webapp` -* Create a virtualenv and activate it. -* After activating it, `pip install --user -r requirements.txt` to +* Create a virtualenv (see below for instructions) and activate it. +* After activating it, `pip install --user -r requirements.txt` to install dependencies. * `./runserver.py` to run the app. * Navigate to `http://127.0.0.1:8080` to watch it in action! - +## Virtualenv instructions +* To create a virtual environment, type in `virtualenv <env_name>`. +* After it initializes, execute `source <env_name>/bin/activate` to activate the virtualenv. diff --git a/requirements.txt b/requirements.txt index 96d6b836dae89b64bf773ca7e86966cbbb434ece..50055448c0af9d0c9dbd925639d3155555121581 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,4 +3,4 @@ Flask-DebugToolbar==0.10.1 Flask-SocketIO==2.9.1 Flask-WTF==0.14.2 Jinja2==2.9.6 - +virtualenv