From 627e9e69d0d1c6e2f992d8d2a29f47872fd76f54 Mon Sep 17 00:00:00 2001 From: Shivamgera Date: Mon, 26 Mar 2018 11:03:04 +0530 Subject: [PATCH] docs: Add python3 to ./tools/provision command. Documentation tweaked by tabbott. --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d8dc208..8adfbcf 100644 --- a/README.md +++ b/README.md @@ -29,19 +29,28 @@ The source code is written in *Python 3*. 4. Run: ``` - ./tools/provision + python3 ./tools/provision ``` This sets up a virtual Python environment in `zulip-api-py-venv`, where `` is your default version of Python. If you would like to specify a different Python version, run ``` - ./tools/provision -p + python3 ./tools/provision -p ``` -5. The above step, if successful, will tell you the command to "source" your - virtual environment. Run that command! +5. If that succeeds, it will print end with printing the following command: + ``` + source /.../python-zulip-api/.../activate + ``` + You can run run this command to enter the virtual environment. + You'll want to run this in each new shell before running commands from `python-zulip-api`. -6. You should now be able to run all the tests within this virtualenv. +6. Once you've entered the virtualenv, you should see something like this on the terminal: + ``` + (zulip-api-py3-venv) user@pc ~/python-zulip-api $ + ``` + You should now be able to run any commands/tests/etc. in this + virtual environment. ### Running tests