From c54ee25ddadb264f0b3cfca1c4ff588c1b92527a Mon Sep 17 00:00:00 2001 From: tpeng Date: Fri, 20 Jun 2014 22:27:55 +0200 Subject: [PATCH] DOC: add prerequisites section --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81702e95f..92b036bee 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,30 @@ Requirements * Works on Linux, Windows, Mac OSX, BSD * Supported browsers: Latest versions of Chrome (recommended) or Firefox +Prerequisites +============= + +You might need to run the following commands to install the required tools & libraries before building portia: + + apt-get install python-pip python-dev libxml2-dev libxslt1-dev libffi-dev libssl-dev + pip install virtualenv + Installation ============ -The recommended way to install dependencies is to use __virtualenv__ and then do: +The recommended way to install dependencies is to use __virtualenv__: + + virtualenv YOUR_ENV_NAME --no-site-packages + +and then do: + source YOUR_ENV_NAME/bin/activate cd slyd pip install -r requirements.txt -As `slybot` is a `slyd` dependency, it will also get installed. Note that you may also need to use `sudo` or `pip --user` if you get permissions problems while installing. +As `slybot` is a `slyd` dependency, it will also get installed. +**Note:** you may need to use `sudo` or `pip --user` if you get permissions problems while installing. Running portia ==============