From ba0f92d2ac196d9e45f0f82d4855d26ddc4c2201 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Thu, 10 May 2018 17:22:27 +0200 Subject: [PATCH] Add documentation on tfw pip package --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5194ad1..de6f5bb 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,13 @@ Just copy and paste the following command in a terminal: `bash -c "$(curl -fsSL https://git.io/vxBfj)"` -Note that your SSH public key must be added to your GitHub user for this to work. +Note that your SSH public key must be added to your GitHub user for this to work, or you mush select HTTPS remotes when prompted. + +By default your IDE will fail to autocomplete code and will complain about missing dependencies. +To fix this you should install the `tfw` pip package in your dev virtualenv: + +- `pip install git+ssh://git@github.com/avatao-content/baseimage-tutorial-framework.git` (SSH) +- `pip install git+https://github.com/avatao-content/baseimage-tutorial-framework.git` (HTTPS) Dependencies: - bash